refactor git_fetch_option.depth and usage

1 files changed, 3 insertions, 1 deletions

diff --git a/include/git2/remote.h b/include/git2/remote.h
index 33f5103ce..f3415d843 100644
--- a/include/git2/remote.h
+++ b/include/git2/remote.h
@@ -744,7 +744,9 @@ typedef struct {
 	git_proxy_options proxy_opts;
 
 	/**
-	 * Depth of the fetch to perform
+	 * Depth of the fetch to perform, has to be a positive integer.
+	 *
+	 * The default is -1, which will fetch the full history.
 	 */
 	int depth;