From: "Martin Ågren" <martin.agren@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Jeff King" <peff@peff.net>,
"Jonathan Nieder" <jrnieder@gmail.com>,
"Stefan Beller" <sbeller@google.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Git Mailing List" <git@vger.kernel.org>
Subject: Re: [PATCH] Documentation/CodingGuidelines: How to document new APIs
Date: Fri, 28 Sep 2018 21:47:23 +0200 [thread overview]
Message-ID: <CAN0heSq4-CXo5dzWdeBiR8nFdRzc-+YXE6h4w7WuB8qEiSBf6g@mail.gmail.com> (raw)
In-Reply-To: <xmqq5zypefcp.fsf@gitster-ct.c.googlers.com>
On Fri, 28 Sep 2018 at 18:51, Junio C Hamano <gitster@pobox.com> 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
next prev parent reply other threads:[~2018-09-28 19:47 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-21 22:35 [PATCHv3 0/8] fetch: make sure submodule oids are fetched Stefan Beller
2018-09-21 22:35 ` [PATCH 1/8] sha1-array: provide oid_array_filter Stefan Beller
2018-09-22 12:58 ` Ævar Arnfjörð Bjarmason
2018-09-25 19:26 ` Stefan Beller
2018-09-26 4:15 ` Jeff King
2018-09-26 17:10 ` Junio C Hamano
2018-09-26 17:49 ` Ævar Arnfjörð Bjarmason
2018-09-26 18:27 ` Junio C Hamano
2018-09-26 18:34 ` Jeff King
2018-09-26 18:43 ` Ævar Arnfjörð Bjarmason
2018-09-26 18:58 ` Jeff King
2018-09-26 19:39 ` Stefan Beller
2018-09-26 19:49 ` Junio C Hamano
2018-09-26 19:59 ` Stefan Beller
2018-09-26 20:19 ` Junio C Hamano
2018-09-26 20:51 ` Jeff King
2018-09-26 21:22 ` Stefan Beller
2018-09-26 20:44 ` On shipping more of our technical docs as manpages Ævar Arnfjörð Bjarmason
2018-09-26 21:40 ` Junio C Hamano
2018-09-26 23:21 ` Stefan Beller
2018-09-27 8:58 ` Ævar Arnfjörð Bjarmason
2018-09-27 6:20 ` Jeff King
2018-09-27 6:34 ` Jonathan Nieder
2018-09-27 6:40 ` Jeff King
2018-09-27 17:36 ` Junio C Hamano
2018-09-27 18:25 ` Jeff King
2018-09-27 21:27 ` [PATCH] Documentation/CodingGuidelines: How to document new APIs Stefan Beller
2018-09-27 21:43 ` Junio C Hamano
2018-09-27 22:21 ` Ævar Arnfjörð Bjarmason
2018-09-27 23:27 ` Jonathan Nieder
2018-09-28 1:11 ` Jeff King
2018-09-28 16:50 ` Junio C Hamano
2018-09-28 17:30 ` [PATCH] strbuf.h: format according to coding guidelines Stefan Beller
2018-09-28 19:54 ` Junio C Hamano
2018-09-28 20:11 ` Junio C Hamano
2018-09-28 21:38 ` Junio C Hamano
2018-09-29 7:38 ` Jeff King
2018-09-28 21:42 ` Junio C Hamano
2018-09-28 21:54 ` Stefan Beller
2018-09-28 19:47 ` Martin Ågren [this message]
2018-09-29 7:46 ` [PATCH] Documentation/CodingGuidelines: How to document new APIs Jeff King
2018-09-28 17:14 ` Stefan Beller
2018-09-29 7:41 ` Jeff King
2018-09-27 6:48 ` [PATCH 1/8] sha1-array: provide oid_array_filter Jeff King
2018-09-21 22:35 ` [PATCH 2/8] submodule.c: fix indentation Stefan Beller
2018-09-21 22:35 ` [PATCH 3/8] submodule.c: sort changed_submodule_names before searching it Stefan Beller
2018-09-21 22:35 ` [PATCH 4/8] submodule: move global changed_submodule_names into fetch submodule struct Stefan Beller
2018-09-21 22:35 ` [PATCH 5/8] submodule.c: do not copy around submodule list Stefan Beller
2018-09-21 22:35 ` [PATCH 6/8] submodule: fetch in submodules git directory instead of in worktree Stefan Beller
2018-09-21 22:35 ` [PATCH 7/8] fetch: retry fetching submodules if needed objects were not fetched Stefan Beller
2018-09-21 22:35 ` [PATCH 8/8] builtin/fetch: check for submodule updates for non branch fetches Stefan Beller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAN0heSq4-CXo5dzWdeBiR8nFdRzc-+YXE6h4w7WuB8qEiSBf6g@mail.gmail.com \
--to=martin.agren@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.com \
--cc=peff@peff.net \
--cc=sbeller@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.