Mercurial > p > roundup > code
changeset 7267:519fb6dca72b
doc: add recommendation for singular class names
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 23 Apr 2023 12:33:31 -0400 |
| parents | 543b9d6d0e11 |
| children | 91125d474c1e |
| files | doc/customizing.txt |
| diffstat | 1 files changed, 6 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/customizing.txt Wed Apr 19 22:30:00 2023 -0400 +++ b/doc/customizing.txt Sun Apr 23 12:33:31 2023 -0400 @@ -788,6 +788,12 @@ number) we reduce the chance that someone mis-types a priority or status - or simply makes a new one up. +Class names are used to access items of that class in the `REST api`_ +interface. The classic tracker was created before the REST interface +was added. It uses the single form (i.e. issue and user not issues and +users) for its classes. Most REST documentation suggests using plural +forms. However, to make your API consistent, use singular forms for +classes that you add. Class and Items ~~~~~~~~~~~~~~~