Skip to content

Commit c31ed7e

Browse files
committed
doc: add recommendation for singular class names
1 parent c17dfb0 commit c31ed7e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/customizing.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -788,6 +788,12 @@ By only requiring a link on the issue (which is stored as a single
788788
number) we reduce the chance that someone mis-types a priority or
789789
status - or simply makes a new one up.
790790

791+
Class names are used to access items of that class in the `REST api`_
792+
interface. The classic tracker was created before the REST interface
793+
was added. It uses the single form (i.e. issue and user not issues and
794+
users) for its classes. Most REST documentation suggests using plural
795+
forms. However, to make your API consistent, use singular forms for
796+
classes that you add.
791797

792798
Class and Items
793799
~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)