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

ethomson · web-flow · commit 5171f44cef8a · 2018-01-20T14:56:12.000Z
message: update docs for git_message_prettify
diff --git 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.

Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,9 @@`
`19`	`19`	`GIT_BEGIN_DECL`
`20`	`20`
`21`	`21`	`/**`
`22`		`- * Clean up message from excess whitespace and make sure that the last line`
`23`		`- * ends with a '\n'.`
	`22`	`+ * Clean up excess whitespace and make sure there is a trailing newline in the message.`
`24`	`23`	`*`
`25`		`- * Optionally, can remove lines starting with a "#".`
	`24`	`+ * Optionally, it can remove lines which start with the comment character.`
`26`	`25`	`*`
`27`	`26`	`* @param out The user-allocated git_buf which will be filled with the`
`28`	`27`	`* cleaned up message.`