Merge pull request #4483 from libgit2/cmn/prettify-docs

message: update docs for git_message_prettify

Merge pull request #4483 from libgit2/cmn/prettify-docs
message: update docs for git_message_prettify
5171f44c · Edward Thomson · GitHub · 820370fe · dcb668ba · 5171f44c
Unverified Commit 5171f44c authored Jan 20, 2018 by Edward Thomson Committed by GitHub Jan 20, 2018
Hide whitespace changes
Inline Side-by-side

Showing with 2 additions and 3 deletions

include/git2/message.h
+2 -3

No files found.
--- a/include/git2/message.h
+++ b/include/git2/message.h
@@ -19,10 +19,9 @@
 GIT_BEGIN_DECL

 /**
- * Clean up message from excess whitespace and make sure that the last line
- * ends with a '\n'.
+ * Clean up excess whitespace and make sure there is a trailing newline in the message.
 *
- * Optionally, can remove lines starting with a "#".
+ * Optionally, it can remove lines which start with the comment character.
 *
 * @param out The user-allocated git_buf which will be filled with the
 *     cleaned up message.