On Fri, Dec 8, 2017 at 8:21 AM, Olga Telezhnaya <[email protected]> wrote: > Write some docs for functions in pretty.h. > Take it as a first draft, they would be changed later. > > Signed-off-by: Olga Telezhnaia <[email protected]> > Mentored-by: Christian Couder <[email protected]> > Mentored by: Jeff King <[email protected]> > --- > 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 *);
