Skip to content

Commit eafad21

Browse files
beruicterencehonles
authored andcommitted
Fix capitalization, markdown syntax link in docs (encode#6621)
The `Pygments` and `Markdown` python packages have first letter capital. Fixed link to markdown syntax to go directly to the syntax page.
1 parent b3bf3a7 commit eafad21

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/topics/documenting-your-api.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The built-in API documentation includes:
1717
### Installation
1818

1919
The `coreapi` library is required as a dependency for the API docs. Make sure
20-
to install the latest version. The `pygments` and `markdown` libraries
20+
to install the latest version. The `Pygments` and `Markdown` libraries
2121
are optional but recommended.
2222

2323
To install the API documentation, you'll need to include it in your project's URLconf:
@@ -277,7 +277,7 @@ When working with viewsets, an appropriate suffix is appended to each generated
277277

278278
The description in the browsable API is generated from the docstring of the view or viewset.
279279

280-
If the python `markdown` library is installed, then [markdown syntax][markdown] may be used in the docstring, and will be converted to HTML in the browsable API. For example:
280+
If the python `Markdown` library is installed, then [markdown syntax][markdown] may be used in the docstring, and will be converted to HTML in the browsable API. For example:
281281

282282
class AccountListView(views.APIView):
283283
"""
@@ -331,7 +331,7 @@ To implement a hypermedia API you'll need to decide on an appropriate media type
331331
[open-api]: https://openapis.org/
332332
[rest-framework-docs]: https://github.com/marcgibbons/django-rest-framework-docs
333333
[apiary]: https://apiary.io/
334-
[markdown]: https://daringfireball.net/projects/markdown/
334+
[markdown]: https://daringfireball.net/projects/markdown/syntax
335335
[hypermedia-docs]: rest-hypermedia-hateoas.md
336336
[image-drf-docs]: ../img/drfdocs.png
337337
[image-django-rest-swagger]: ../img/django-rest-swagger.png

0 commit comments

Comments
 (0)