CodingGuidelines: instruct to name arrays in singular

Arrays should be named in the singular form, ensuring that when
accessing an element within an array (e.g. dog[0]) it's clear that
we're referring to an element instead of a collection.

Add a new rule to CodingGuidelines asking for arrays to be named in
singular instead of plural.

Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Lucas Seiki Oshiro <lucasseikioshiro@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Lucas Seiki Oshiro
2026-02-25 13:32:10 -03:00
committed by Junio C Hamano
parent 02a0d297a1
commit c63e64e04d

View File

@@ -656,6 +656,19 @@ For C programs:
unsigned other_field:1;
unsigned field_with_longer_name:1;
- Array names should be named in the singular form if the individual items are
subject of use. E.g.:
char *dog[] = ...;
walk_dog(dog[0]);
walk_dog(dog[1]);
Cases where the array is employed as a whole rather than as its unit parts,
the plural forms is preferable. E.g:
char *dogs[] = ...;
walk_all_dogs(dogs);
For Perl programs:
- Most of the C guidelines above apply.