encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-28 00:49:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

improve documentation

Browse Source
This commit is contained in:
Dhaval Mehta 2020-02-13 00:21:22 +05:30
parent 10cdd2bde3
commit ee97de3269
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api-guide/schemas.md
View File

@ -224,7 +224,7 @@ Tags can be used to group logical operations. Each tag name in the list MUST be
**Django REST Framework generates tags automatically with following logic:** **Django REST Framework generates tags automatically with following logic:**
1. Extract tag from `ViewSet`. 1. Extract tag from `ViewSet`.
1. If `ViewSet` name ends with `ViewSet`, or `View`; remove it. 1. If `ViewSet` name ends with `ViewSet`, or `View`; remove it.
2. Convert class name into lowercase words & join each word with a space. 2. Convert class name into lowercase words & join each word using a space.
Examples: Examples:
@ -236,7 +236,7 @@ Tags can be used to group logical operations. Each tag name in the list MUST be
PascalCaseXYZ | ['pascal case xyz'] PascalCaseXYZ | ['pascal case xyz']
IPAddressView | ['ip address'] IPAddressView | ['ip address']
2. If View is not an instance of ViewSet, tag name will be first element from the path. Also, any `-` or `_` in path name will be converted as a space. 2. If View is not an instance of ViewSet, tag name will be first element from the path. Also, any `-` or `_` in path name will be replaced by a space.
Consider below examples. Consider below examples.
Example 1: Consider a user management system. The following table will illustrate the tag generation logic. Example 1: Consider a user management system. The following table will illustrate the tag generation logic.