8000 Clarify "Helping with Documentation" by csabella · Pull Request #335 · python/devguide · GitHub
[go: up one dir, main page]
Skip to content

Clarify "Helping with Documentation" #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 19, 2018
Merged

Clarify "Helping with Documentation" #335

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
80df693
Clarify "Helping with Documentation"
csabella Mar 6, 2018
0181db8
Suggested changes.
csabella Mar 11, 2018
9742c10
Suggested changes.
csabella Mar 11, 2018
cd62985
Remove extra "the"
csabella Mar 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docquality.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ keeping a high level of quality takes a lot of effort. Help is always
appreciated with the documentation, and it requires little programming
experience (with or without Python).


Python Documentation
--------------------

:ref:`Documenting Python <documenting>` covers the details of how Python's
documentation works.
It includes an explanation of the markup used (although you can figure a lot
Expand Down Expand Up @@ -76,9 +80,10 @@ Helping with the Developer's Guide

.. highlight:: console

The Developer's Guide uses the same process as the main Python documentation,
except for some small differences. The source lives in a `separate
repository`_ and bug reports should be submitted to the `the GitHub tracker`_.
The Developer's Guide (what you're reading now) uses the same process as the
main Python documentation, except for some small differences. The source
lives in a `separate repository`_ and bug reports should be submitted to
the `its GitHub tracker`_.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small correction still needed after the PR split the. Thanks @csabella 👍


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

.. _separate repository:
.. _devguide repo: https://github.com/python/devguide
.. _the GitHub tracker: https://github.com/python/devguide/issues
.. _its GitHub tracker: https://github.com/python/devguide/issues
.. _Sphinx: http://www.sphinx-doc.org/
0