summaryrefslogtreecommitdiff
path: root/Documentation/technical/api-credentials.txt
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2018-09-28 09:50:14 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2018-09-29 11:18:01 -0700
commitd9f079ad1a866151fea01f7f977dfbd1ba4d97f7 (patch)
treec0d420eeaac4fd594ec4f02362f2d1d1ff99e9c6 /Documentation/technical/api-credentials.txt
parentGit 2.19 (diff)
downloadtgif-d9f079ad1a866151fea01f7f977dfbd1ba4d97f7.tar.xz
CodingGuidelines: document the API in *.h files
It makes it harder to let the API description and the reality drift apart if the doc is kept close to the implementation or the header of the API. We have been slowly migrating API docs out of the Documentation/technical/api-* to *.h files, and the development community generally considers that how inline docs in strbuf.h is done the best current practice. 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. Helped-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical/api-credentials.txt')
0 files changed, 0 insertions, 0 deletions