@matheusbsbs / matheus-bagliano / commits / e0f9095aaa
Fork 0

notes.h: fix typos in comment

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 <sunshine@sunshineco.com> Signed-off-by: Denton Liu <liu.denton@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Denton Liu committed Dec 18, 2019 at 10:17 UTC e0f9095aaa56f5c731faced2e61ca48df5caedfb
1 file changed +2 -2
notes.h
+2 -2
@@ -268,11 +268,11 @@ void init_display_notes(struct display_notes_opt *opt);
268 /*
269 * This family of functions enables or disables the display of notes. In
270 * particular, 'enable_default_display_notes' will display the default notes,
271 - * 'enable_default_display_notes' will display the notes ref 'ref' and
271 + * 'enable_ref_display_notes' will display the notes ref 'ref' and
272 * 'disable_display_notes' will disable notes, including those added by previous
273 * invocations of the 'enable_*_display_notes' functions.
274 *
275 - * 'show_notes' is a points to a boolean which will be set to 1 if notes are
275 + * 'show_notes' is a pointer to a boolean which will be set to 1 if notes are
276 * displayed, else 0. It must not be NULL.
277 */
278 void enable_default_display_notes(struct display_notes_opt *opt, int *show_notes);