From 441dcac1d7b5669b19e4ce86dcabeb5d9bfd5874 Mon Sep 17 00:00:00 2001 From: Aleksey Kulikov Date: Fri, 28 Jan 2022 21:03:09 +0300 Subject: [PATCH] docs(checkout): clarify how methods work Add to docs that by default checkout processes all the files --- lib/src/checkout.dart | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/src/checkout.dart b/lib/src/checkout.dart index 74d0a48..e3b8d8f 100644 --- a/lib/src/checkout.dart +++ b/lib/src/checkout.dart @@ -22,7 +22,8 @@ class Checkout { /// /// [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. static void head({ @@ -51,7 +52,8 @@ class Checkout { /// /// [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. static void index({ @@ -84,7 +86,8 @@ class Checkout { /// /// [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. static void reference({ @@ -129,7 +132,8 @@ class Checkout { /// /// [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. static void commit({