Re: [PATCH Outreachy 2/2] format: create docs for pretty.h

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Dec 8, 2017, 19:26 UTC
Message-ID: <CAPig+cSjSHJoBz5rWBZE=AO=XhEk6ZoGkmqiuk_r9PgAe5wt4w@mail.gmail.com>
In-Reply-To: <01020160364a2471-0e40e237-80b4-485c-a987-9c83206a2ee5-000000@eu-west-1.amazonses.com>

On Fri, Dec 8, 2017 at 8:21 AM, Olga Telezhnaya <olyatelezhnaya@gmail.com> wrote:

Show 21 quoted lines

> Write some docs for functions in pretty.h.
> Take it as a first draft, they would be changed later.
>
> Signed-off-by: Olga Telezhnaia <olyatelezhnaya@gmail.com>
> Mentored-by: Christian Couder <christian.couder@gmail.com>
> Mentored by: Jeff King <peff@peff.net>
> ---
> diff --git a/pretty.h b/pretty.h
> @@ -57,31 +58,74 @@ struct userformat_want {
> +/*
> + * Create a text message about commit using given "format" and "context".
> + * Put the result to "sb".
> + * Please use this function for custom formats.
> + */
>  void format_commit_message(const struct commit *commit,
>                         const char *format, struct strbuf *sb,
>                         const struct pretty_print_context *context);
>
> +/*
> + * Parse given arguments from "arg", check it for correctness and
> + * fill struct rev_info.

To be consistent with the way you formatted the other comments, I think you'd want quotes around rev_info.

> + */
>  void get_commit_format(const char *arg, struct rev_info *);