Skip to content

Commit ea0b3b3

Browse files
beruiccarltongibson
authored andcommitted
Fix typo (#5687)
Fixed `include_docs_url` to be `include_docs_urls`
1 parent 4bcbf69 commit ea0b3b3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/topics/documenting-your-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ When using viewsets, you should use the relevant action names as delimiters.
9393

9494
### `documentation` API Reference
9595

96-
The `rest_framework.documentation` module provides three helper functions to help configure the interactive API documentation, `include_docs_url` (usage shown above), `get_docs_view` and `get_schemajs_view`.
96+
The `rest_framework.documentation` module provides three helper functions to help configure the interactive API documentation, `include_docs_urls` (usage shown above), `get_docs_view` and `get_schemajs_view`.
9797

98-
`include_docs_url` employs `get_docs_view` and `get_schemajs_view` to generate the url patterns for the documentation page and JavaScript resource that exposes the API schema respectively. They expose the following options for customisation. (`get_docs_view` and `get_schemajs_view` ultimately call `rest_frameworks.schemas.get_schema_view()`, see the Schemas docs for more options there.)
98+
`include_docs_urls` employs `get_docs_view` and `get_schemajs_view` to generate the url patterns for the documentation page and JavaScript resource that exposes the API schema respectively. They expose the following options for customisation. (`get_docs_view` and `get_schemajs_view` ultimately call `rest_frameworks.schemas.get_schema_view()`, see the Schemas docs for more options there.)
9999

100-
#### `include_docs_url`
100+
#### `include_docs_urls`
101101

102102
* `title`: Default `None`. May be used to provide a descriptive title for the schema definition.
103103
* `description`: Default `None`. May be used to provide a description for the schema definition.

0 commit comments

Comments
 (0)