worktree: document that is_prunable sets error messages

ethomson · ethomson · commit 12b54ae00948 · 2023-05-16T12:40:16.000+01:00
When a worktree is not prunable, an error message will be set with
information about why. Document that.
diff --git 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.

Original file line number	Diff line number	Diff line change
`@@ -237,7 +237,9 @@ GIT_EXTERN(int) git_worktree_prune_options_init(`
`237`	`237`	`*`
`238`	`238`	`* If the worktree is not valid and not locked or if the above`
`239`	`239`	`* flags have been passed in, this function will return a`
`240`		`- * positive value.`
	`240`	`+ * positive value. If the worktree is not prunable, an error`
	`241`	+ * message will be set (visible in `giterr_last`) with details about
	`242`	`+ * why.`
`241`	`243`	`*`
`242`	`244`	`* @param wt Worktree to check.`
`243`	`245`	`* @param opts The prunable options.`