Commit 5171f44cef8a0f0dfadcaf371c689cfcf43222b0

Edward Thomson 2018-01-20T14:56:12

Merge pull request #4483 from libgit2/cmn/prettify-docs message: update docs for git_message_prettify

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/git2/message.h b/include/git2/message.h
index 3293462..42ca3e5 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.