Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit af029de

Browse files
committed
Issue #20255: Update the about and bugs pages.
2 parents d7fb791 + 71337cb commit af029de

3 files changed

Lines changed: 28 additions & 16 deletions

File tree

Doc/about.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a
77
document processor specifically written for the Python documentation.
88

99
.. _reStructuredText: http://docutils.sf.net/rst.html
10-
.. _Sphinx: http://sphinx.pocoo.org/
10+
.. _Sphinx: http://sphinx-doc.org/
1111

1212
.. In the online version of these documents, you can submit comments and suggest
1313
changes directly on the documentation pages.
1414
15-
Development of the documentation and its toolchain takes place on the
16-
[email protected] mailing list. We're always looking for volunteers wanting
17-
to help with the docs, so feel free to send a mail there!
15+
Development of the documentation and its toolchain is an entirely volunteer
16+
effort, just like Python itself. If you want to contribute, please take a
17+
look at the :ref:`reporting-bugs` page for information on how to do so. New
18+
volunteers are always welcome!
1819

1920
Many thanks go to:
2021

@@ -26,9 +27,6 @@ Many thanks go to:
2627
<http://effbot.org/zone/pyref.htm>`_ project from which Sphinx got many good
2728
ideas.
2829

29-
See :ref:`reporting-bugs` for information how to report bugs in this
30-
documentation, or Python itself.
31-
3230

3331
Contributors to the Python Documentation
3432
----------------------------------------

Doc/bugs.rst

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,17 @@ Documentation bugs
1313
==================
1414

1515
If you find a bug in this documentation or would like to propose an improvement,
16-
please send an e-mail to [email protected] describing the bug and where you found
17-
it. If you have a suggestion how to fix it, include that as well.
16+
please submit a bug report on the :ref:`tracker <using-the-tracker>`. If you
17+
have a suggestion how to fix it, include that as well.
1818

19-
[email protected] is a mailing list run by volunteers; your request will be
20-
noticed, even if it takes a while to be processed.
19+
If you're short on time, you can also email your bug report to [email protected].
20+
'docs@' is a mailing list run by volunteers; your request will be noticed,
21+
though it may take a while to be processed.
2122

22-
Of course, if you want a more persistent record of your issue, you can use the
23-
issue tracker for documentation bugs as well.
23+
.. seealso::
24+
`Documentation bugs`_ on the Python issue tracker
2425

26+
.. _using-the-tracker:
2527

2628
Using the Python issue tracker
2729
==============================
@@ -62,9 +64,6 @@ taken on the bug.
6264

6365
.. seealso::
6466

65-
`Python Developer's Guide <http://docs.python.org/devguide/>`_
66-
Detailed description of the issue workflow and developers tools.
67-
6867
`How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_
6968
Article which goes into some detail about how to create a useful bug report.
7069
This describes what kind of information is useful and why it is useful.
@@ -73,3 +72,16 @@ taken on the bug.
7372
Information about writing a good bug report. Some of this is specific to the
7473
Mozilla project, but describes general good practices.
7574

75+
76+
Getting started contributing to Python yourself
77+
===============================================
78+
79+
Beyond just reporting bugs that you find, you are also welcome to submit
80+
patches to fix them. You can find more information on how to get started
81+
patching Python in the `Python Developer's Guide`_. If you have questions,
82+
the `core-mentorship mailing list`_ is a friendly place to get answers to
83+
any and all questions pertaining to the process of fixing issues in Python.
84+
85+
.. _Documentation bugs: http://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity
86+
.. _Python Developer's Guide: http://docs.python.org/devguide/
87+
.. _core-mentorship mailing list: https://mail.python.org/mailman/listinfo/core-mentorship/

Misc/NEWS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,8 @@ Build
475475
Documentation
476476
-------------
477477

478+
- Issue #20255: Update the about and bugs pages.
479+
478480
- Issue #20253: Fixed a typo in the ipaddress docs that advertised an
479481
illegal attribute name. Found by INADA Naoki.
480482

0 commit comments

Comments
 (0)