Skip to content

Commit 521d3ef

Browse files
committed
Merge branch 'cm/notes-comment-fix'
A stale in-code comment has been updated. * cm/notes-comment-fix: notes: correct documentation of format_display_notes()
2 parents b3e0981 + d490772 commit 521d3ef

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

notes.h

+3-5
Original file line numberDiff line numberDiff line change
@@ -276,12 +276,10 @@ void init_display_notes(struct display_notes_opt *opt);
276276

277277
/*
278278
* Append notes for the given 'object_sha1' from all trees set up by
279-
* init_display_notes() to 'sb'. The 'flags' are a bitwise
280-
* combination of
279+
* init_display_notes() to 'sb'.
281280
*
282-
* - NOTES_SHOW_HEADER: add a 'Notes (refname):' header
283-
*
284-
* - NOTES_INDENT: indent the notes by 4 places
281+
* If 'raw' is false the note will be indented by 4 places and
282+
* a 'Notes (refname):' header added.
285283
*
286284
* You *must* call init_display_notes() before using this function.
287285
*/

0 commit comments

Comments
 (0)