# [PATCH] notes: correct documentation of format_display_notes()

1 messages from 2019-05-04 to 2019-05-04. Participants: Chris Mayo.
Thread: https://gitlist.dev/t/51032

## Chris Mayo, 2019-05-04 18:45

Subject: [PATCH] notes: correct documentation of format_display_notes()
Message-ID: <20190504184507.4405-1-aklhfex@gmail.com>
URL: https://gitlist.dev/e/20190504184507.4405-1-aklhfex%40gmail.com

```
'flags' parameter was replaced by 'raw' in commit:
76141e2e62 ("format_note(): simplify API", 2012-10-17)

Signed-off-by: Chris Mayo <aklhfex@gmail.com>
---
 notes.h | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/notes.h b/notes.h
index 414bc6855a..76337f2384 100644
--- a/notes.h
+++ b/notes.h
@@ -276,12 +276,10 @@ void init_display_notes(struct display_notes_opt *opt);
 
 /*
  * Append notes for the given 'object_sha1' from all trees set up by
- * init_display_notes() to 'sb'.  The 'flags' are a bitwise
- * combination of
+ * init_display_notes() to 'sb'.
  *
- * - NOTES_SHOW_HEADER: add a 'Notes (refname):' header
- *
- * - NOTES_INDENT: indent the notes by 4 places
+ * If 'raw' is false the note will be indented by 4 places and
+ * a 'Notes (refname):' header added.
  *
  * You *must* call init_display_notes() before using this function.
  */
-- 
2.21.0


```