Merge pull request #4773 from RandomSort/giterr

Document giterr_last() use only after error. #4772

1 files changed, 6 insertions, 1 deletions

diff --git a/include/git2/errors.h b/include/git2/errors.h
index 00fbed157..676434f4a 100644
--- a/include/git2/errors.h
+++ b/include/git2/errors.h
@@ -109,7 +109,12 @@ typedef enum {
 
 /**
  * Return the last `git_error` object that was generated for the
- * current thread or NULL if no error has occurred.
+ * current thread.
+ *
+ * The default behaviour of this function is to return NULL if no previous error has occurred.
+ * However, libgit2's error strings are not cleared aggressively, so a prior
+ * (unrelated) error may be returned. This can be avoided by only calling
+ * this function if the prior call to a libgit2 API returned an error.
  *
  * @return A git_error object.
  */