On Fri, 28 Sep 2018 at 18:51, Junio C Hamano <gitster@xxxxxxxxx> wrote: > We recommend documenting in the header over documenting near the > implementation to encourage people to write the docs that are > readable without peeking at the implemention. s/implemention/implementation/ > - - When you come up with an API, document it. > + - When you come up with an API, document it the functions and the s/it the/the/ > + structures in the header file that exposes the API to its callers. > + Use what is in "strbuf.h" as a model to decide the appropriate tone > + in which the description is given, and the level of details to put > + in the description. Martin
