summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRemy Suen <remy.suen@gmail.com>2017-02-09 19:12:31 +0900
committerGitHub <noreply@github.com>2017-02-09 19:12:31 +0900
commit93e2c74493cebb4503b8af793d4150b528efbdf5 (patch)
tree6356a04ec2ae6ada246d492aabb9ddd2cc82bf2b
parentb4bd5e8453fddbac56d4f27a4b161945c910e4c9 (diff)
downloadlibgit2-93e2c74493cebb4503b8af793d4150b528efbdf5.tar.gz
Flag optional parameters for apply and pop
The options parameter in both git_stash_apply and git_stash_pop can be NULL. They should be flagged as such in the documentation.
-rw-r--r--include/git2/stash.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/git2/stash.h b/include/git2/stash.h
index 733d75a7f..3af9cde38 100644
--- a/include/git2/stash.h
+++ b/include/git2/stash.h
@@ -173,7 +173,7 @@ GIT_EXTERN(int) git_stash_apply_init_options(
* @param repo The owning repository.
* @param index The position within the stash list. 0 points to the
* most recent stashed state.
- * @param options Options to control how stashes are applied.
+ * @param options Optional options to control how stashes are applied.
*
* @return 0 on success, GIT_ENOTFOUND if there's no stashed state for the
* given index, GIT_EMERGECONFLICT if changes exist in the working
@@ -242,7 +242,7 @@ GIT_EXTERN(int) git_stash_drop(
* @param repo The owning repository.
* @param index The position within the stash list. 0 points to the
* most recent stashed state.
- * @param options Options to control how stashes are applied.
+ * @param options Optional options to control how stashes are applied.
*
* @return 0 on success, GIT_ENOTFOUND if there's no stashed state for the given
* index, or error code. (see git_stash_apply() above for details)