diff options
| -rw-r--r-- | include/git2/worktree.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/include/git2/worktree.h b/include/git2/worktree.h index bb024dc94..9193eaf34 100644 --- a/include/git2/worktree.h +++ b/include/git2/worktree.h @@ -237,7 +237,9 @@ GIT_EXTERN(int) git_worktree_prune_options_init( * * If the worktree is not valid and not locked or if the above * flags have been passed in, this function will return a - * positive value. + * positive value. If the worktree is not prunable, an error + * message will be set (visible in `giterr_last`) with details about + * why. * * @param wt Worktree to check. * @param opts The prunable options. |