Mercurial > p > roundup > code
comparison doc/customizing.txt @ 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 | 570abc4c6548 |
| children | 91125d474c1e |
comparison
equal
deleted
inserted
replaced
| 7266:543b9d6d0e11 | 7267:519fb6dca72b |
|---|---|
| 786 | 786 |
| 787 By only requiring a link on the issue (which is stored as a single | 787 By only requiring a link on the issue (which is stored as a single |
| 788 number) we reduce the chance that someone mis-types a priority or | 788 number) we reduce the chance that someone mis-types a priority or |
| 789 status - or simply makes a new one up. | 789 status - or simply makes a new one up. |
| 790 | 790 |
| 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. | |
| 791 | 797 |
| 792 Class and Items | 798 Class and Items |
| 793 ~~~~~~~~~~~~~~~ | 799 ~~~~~~~~~~~~~~~ |
| 794 | 800 |
| 795 A Class defines a particular class (or type) of data that will be stored | 801 A Class defines a particular class (or type) of data that will be stored |