summaryrefslogtreecommitdiff
path: root/commit.c
diff options
context:
space:
mode:
authorPatrick Steinhardt <ps@pks.im>2024-07-30 09:24:43 +0200
committerJunio C Hamano <gitster@pobox.com>2024-07-30 13:50:25 -0700
commit541204aabea80ce466b5f62bf6613cdaf104dd5a (patch)
tree1656649c2e8be365c905c98b9f54e7ac5b53f3e4 /commit.c
parent7df3f55b92ef39239b7b84fee6b89a87a304a58f (diff)
Documentation: document naming schema for structs and their functions
We nowadays have a proper mishmash of struct-related functions that are called `<verb>_<struct>` (e.g. `clear_prio_queue()`) versus functions that are called `<struct>_<verb>` (e.g. `strbuf_clear()`). While the former style may be easier to tie into a spoken conversation, most of our communication happens in text anyway. Furthermore, prefixing functions with the name of the structure they operate on makes it way easier to group them together, see which functions are related, and will also help folks who are using code completion. Let's thus settle on one style, namely the one where functions start with the name of the structure they operate on. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'commit.c')
0 files changed, 0 insertions, 0 deletions