diff options
| author | Carlos Martín Nieto <cmn@dwim.me> | 2018-01-19 01:11:37 +0000 |
|---|---|---|
| committer | Carlos Martín Nieto <cmn@dwim.me> | 2018-01-19 01:11:37 +0000 |
| commit | dcb668bac3a54af02814c39405503eab2f18d5d2 (patch) | |
| tree | 9205b9558687d3ebd605f99b02c8d4ec6594f92c | |
| parent | 4893a9c01c8da084eb995178f80d0d453109056e (diff) | |
| download | libgit2-cmn/prettify-docs.tar.gz | |
message: update docs for git_message_prettifycmn/prettify-docs
We used to hard-code the octothorpe as the comment character and the
documentation still mentions this even though we accept the comment character as
a parameter.
Update the line to indicate this and clean up the first paragraph a bit.
| -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. |