notes.h: fix typos in comment

Commit Message

Denton Liu Dec. 18, 2019, 6:17 p.m. UTC

In 1d7297513d (notes: break set_display_notes() into smaller functions,
2019-12-11), we introduced a comment which had a couple of typos. In the
first typo, we referenced 'enable_default_display_notes' instead of
'enable_ref_display_notes'. In the second typo, we wrote "is a points to"
instead of "is a pointer to". Correct both of these typos.

Reported-by: Eric Sunshine <[e-mail]>
Signed-off-by: Denton Liu <[e-mail]>
---
This patch is based on top of 'dl/format-patch-notes-config-fixup'.
Thanks for catching the typo, Eric!

 notes.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Patch

diff --git a/notes.h b/notes.h
index 3e78448181..bbab1961ca 100644
--- a/notes.h
+++ b/notes.h
@@ -268,11 +268,11 @@  void init_display_notes(struct display_notes_opt *opt);
 /*
  * This family of functions enables or disables the display of notes. In
  * particular, 'enable_default_display_notes' will display the default notes,
- * 'enable_default_display_notes' will display the notes ref 'ref' and
+ * 'enable_ref_display_notes' will display the notes ref 'ref' and
  * 'disable_display_notes' will disable notes, including those added by previous
  * invocations of the 'enable_*_display_notes' functions.
  *
- * 'show_notes' is a points to a boolean which will be set to 1 if notes are
+ * 'show_notes' is a pointer to a boolean which will be set to 1 if notes are
  * displayed, else 0. It must not be NULL.
  */
 void enable_default_display_notes(struct display_notes_opt *opt, int *show_notes);