Siklos/libgit2dart
1
0
Fork 0
mirror of https://github.com/SkinnyMind/libgit2dart.git synced 2025-05-05 04:39:07 -04:00
Code Issues Projects Releases Wiki Activity

docs(checkout): clarify how methods work

Browse source 
Add to docs that by default checkout processes all the files
This commit is contained in:
Aleksey Kulikov 2022-01-28 21:03:09 +03:00
parent ed62447eb2
commit 441dcac1d7
1 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
lib/src/checkout.dart
View file

@ -22,7 +22,8 @@ class Checkout {
/// ///
/// [directory] is optional alternative checkout path to workdir. /// [directory] is optional alternative checkout path to workdir.
/// ///
/// [paths] is optional list of files to checkout. /// [paths] is optional list of files to checkout (by default all paths are
/// processed).
/// ///
/// Throws a [LibGit2Error] if error occured. /// Throws a [LibGit2Error] if error occured.
static void head({ static void head({
@ -51,7 +52,8 @@ class Checkout {
/// ///
/// [directory] is optional alternative checkout path to workdir. /// [directory] is optional alternative checkout path to workdir.
/// ///
/// [paths] is optional list of files to checkout. /// [paths] is optional list of files to checkout (by default all paths are
/// processed).
/// ///
/// Throws a [LibGit2Error] if error occured. /// Throws a [LibGit2Error] if error occured.
static void index({ static void index({
@ -84,7 +86,8 @@ class Checkout {
/// ///
/// [directory] is optional alternative checkout path to workdir. /// [directory] is optional alternative checkout path to workdir.
/// ///
/// [paths] is optional list of files to checkout. /// [paths] is optional list of files to checkout (by default all paths are
/// processed).
/// ///
/// Throws a [LibGit2Error] if error occured. /// Throws a [LibGit2Error] if error occured.
static void reference({ static void reference({
@ -129,7 +132,8 @@ class Checkout {
/// ///
/// [directory] is optional alternative checkout path to workdir. /// [directory] is optional alternative checkout path to workdir.
/// ///
/// [paths] is optional list of files to checkout. /// [paths] is optional list of files to checkout (by default all paths are
/// processed).
/// ///
/// Throws a [LibGit2Error] if error occured. /// Throws a [LibGit2Error] if error occured.
static void commit({ static void commit({