diff options
Diffstat (limited to 'docs/internals')
| -rw-r--r-- | docs/internals/contributing/writing-documentation.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index b519fdbd86..09a790b4a3 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -520,7 +520,7 @@ define some extra description units: Django's documentation uses a custom ``console`` directive for documenting command-line examples involving ``django-admin``, ``manage.py``, ``python``, -etc.). In the HTML documentation, it renders a two-tab UI, with one tab showing +etc. In the HTML documentation, it renders a two-tab UI, with one tab showing a Unix-style command prompt and a second tab showing a Windows prompt. For example, you can replace this fragment: @@ -584,7 +584,7 @@ blank line and an optional description (indented). General improvements or other changes to the APIs that should be emphasized should use the "``.. versionchanged:: X.Y``" directive (with the same format -as the ``versionadded`` mentioned above. +as the ``versionadded`` mentioned above). These ``versionadded`` and ``versionchanged`` blocks should be "self-contained." In other words, since we only keep these annotations around |