8000 Clarify "Helping with Documentation" (#335) · python/devguide@0ef5fe6 · GitHub
[go: up one dir, main page]

Skip to content

Commit 0ef5fe6

Browse files
csabellawillingc
authored andcommitted
Clarify "Helping with Documentation" (#335)
* Clarify "Helping with Documentation" * Suggested changes. * Suggested changes. * Remove extra "the"
1 parent fc40015 commit 0ef5fe6

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docquality.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ keeping a high level of quality takes a lot of effort. Help is always
88
appreciated with the documentation, and it requires little programming
99
experience (with or without Python).
1010

11+
12+
Python Documentation
13+
--------------------
14+
1115
:ref:`Documenting Python <documenting>` covers the details of how Python's
1216
documentation works.
1317
It includes an explanation of the markup used (although you can figure a lot
@@ -76,9 +80,10 @@ Helping with the Developer's Guide
7680

7781
.. highlight:: console
7882

79-
The Developer's Guide uses the same process as the main Python documentation,
80-
except for some small differences. The source lives in a `separate
81-
repository`_ and bug reports should be submitted to the `the GitHub tracker`_.
83+
The Developer's Guide (what you're reading now) uses the same process as the
84+
main Python documentation, except for some small differences. The source
85+
lives in a `separate repository`_ and bug reports should be submitted to
86+
`its GitHub tracker`_.
8287

8388
To submit a :doc:`pull request <pullrequest>` you can fork the
8489
`devguide repo`_ to your GitHub account and clone it using::
@@ -112,5 +117,5 @@ that may be different from the main documentation.
112117

113118
.. _separate repository:
114119
.. _devguide repo: https://github.com/python/devguide
115-
.. _the GitHub tracker: https://github.com/python/devguide/issues
120+
.. _its GitHub tracker: https://github.com/python/devguide/issues
116121
.. _Sphinx: http://www.sphinx-doc.org/

0 commit comments

Comments
 (0)
0