Skip to content

Improve clarity and formatting in help-documenting.rst #1746

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

Closed
Parth-Nakti wants to merge 2 commits into from
+10 −11
Closed

Improve clarity and formatting in help-documenting.rst #1746

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fe256b
Improve clarity and formatting in help-documenting.rst
Parth-Nakti Feb 28, 2026
1d9d867
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 28, 2026
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
21 changes: 10 additions & 11 deletions documentation/help-documenting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
Helping with documentation
==========================

Python is known for having well-written documentation. Maintaining the
documentation's accuracy and keeping a high level of quality takes a lot of
effort. Community members, like you, help with writing, editing, and updating
content, and these contributions are appreciated and welcomed.
Python is known for its well-written documentation. Maintaining its accuracy
and high quality requires significant effort. Community members like you help
by writing, editing, and updating content, and these contributions are greatly
appreciated.

This high-level **Helping with Documentation** section provides:
This high-level "Helping with Documentation" section provides:

* an overview of Python's documentation
* how to help with documentation issues
* information on proofreading
* An overview of Python's documentation
* Guidance on how to help with documentation issues
* Information on proofreading

You will find extensive and detailed information on how to write documentation
and submit changes on the :ref:`Documenting Python <documenting>` page.
Expand Down Expand Up @@ -46,9 +46,8 @@ are discussed.
Helping with documentation issues
=================================

If you look at `documentation issues`_ on the `issue tracker`_, you
will find various documentation problems that may need work. Issues vary from
typos to unclear documentation and items lacking documentation.
If you browse documentation issues on the issue tracker,
you will find a range of problems that may need attention.

If you see a documentation issue that you would like to tackle, you can:

Expand Down