Commit fb68f1807139fcfe4938fd020f4b1de68252335e

Edward Thomson 2022-06-13T21:44:05

status: update documentation for default options

diff --git a/include/git2/status.h b/include/git2/status.h
index d8f9663..bb28e87 100644
--- a/include/git2/status.h
+++ b/include/git2/status.h
@@ -227,13 +227,16 @@ typedef struct {
 
 	/**
 	 * The `show` value is one of the `git_status_show_t` constants that
-	 * control which files to scan and in what order.
+	 * control which files to scan and in what order. The default is
+	 * `GIT_STATUS_SHOW_INDEX_AND_WORKDIR`.
 	 */
 	git_status_show_t show;
 
 	/**
 	 * The `flags` value is an OR'ed combination of the
-	 * `git_status_opt_t` values above.
+	 * `git_status_opt_t` values above. The default is
+	 * `GIT_STATUS_OPT_DEFAULTS`, which matches git's default
+	 * behavior.
 	 */
 	unsigned int      flags;