diff options
author | Edward Thomson <ethomson@edwardthomson.com> | 2018-01-20 14:56:12 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-01-20 14:56:12 +0000 |
commit | 5171f44cef8a0f0dfadcaf371c689cfcf43222b0 (patch) | |
tree | eb866bec5563545df624b657c25ac3e2a8c84f1b | |
parent | 820370fe846167faaeabb2238cae900489af6bb8 (diff) | |
parent | dcb668bac3a54af02814c39405503eab2f18d5d2 (diff) | |
download | libgit2-5171f44cef8a0f0dfadcaf371c689cfcf43222b0.tar.gz |
Merge pull request #4483 from libgit2/cmn/prettify-docs
message: update docs for git_message_prettify
-rw-r--r-- | include/git2/message.h | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/include/git2/message.h b/include/git2/message.h index 329346285..42ca3e5c2 100644 --- 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. |