cpython: 74d138cfe564 (original) (raw)

Mercurial > cpython

changeset 88482:74d138cfe564 2.7

Issue #20255: Update the about and bugs pages. [#20255]

Zachary Ware zachary.ware@gmail.com
date Tue, 14 Jan 2014 16:01:32 -0600
parents 1885e1768ff9
children 84cf25da86e8
files Doc/about.rst Doc/bugs.rst Misc/NEWS
diffstat 3 files changed, 28 insertions(+), 16 deletions(-)[+] [-] Doc/about.rst 12 Doc/bugs.rst 30 Misc/NEWS 2

line wrap: on

line diff

--- a/Doc/about.rst +++ b/Doc/about.rst @@ -7,14 +7,15 @@ These documents are generated from reSt[](#l1.3) document processor specifically written for the Python documentation.[](#l1.4) [](#l1.5) .. _reStructuredText: http://docutils.sf.net/rst.html[](#l1.6) -.. _Sphinx: http://sphinx.pocoo.org/[](#l1.7) +.. _Sphinx: http://sphinx-doc.org/[](#l1.8) [](#l1.9) .. In the online version of these documents, you can submit comments and suggest[](#l1.10) changes directly on the documentation pages.[](#l1.11) [](#l1.12) -Development of the documentation and its toolchain takes place on the[](#l1.13) -docs@python.org mailing list. We're always looking for volunteers wanting[](#l1.14) -to help with the docs, so feel free to send a mail there![](#l1.15) +Development of the documentation and its toolchain is an entirely volunteer[](#l1.16) +effort, just like Python itself. If you want to contribute, please take a[](#l1.17) +look at the :ref:reporting-bugs page for information on how to do so. New[](#l1.18) +volunteers are always welcome![](#l1.19) [](#l1.20) Many thanks go to:[](#l1.21) [](#l1.22) @@ -26,9 +27,6 @@ Many thanks go to:[](#l1.23) <http://effbot.org/zone/pyref.htm>_ project from which Sphinx got many good ideas. -See :ref:reporting-bugs for information how to report bugs in this -documentation, or Python itself. - Contributors to the Python Documentation ----------------------------------------

--- a/Doc/bugs.rst +++ b/Doc/bugs.rst @@ -13,15 +13,17 @@ Documentation bugs ================== If you find a bug in this documentation or would like to propose an improvement, -please send an e-mail to docs@python.org describing the bug and where you found -it. If you have a suggestion how to fix it, include that as well. +please submit a bug report on the :ref:tracker <using-the-tracker>. If you +have a suggestion how to fix it, include that as well. -docs@python.org is a mailing list run by volunteers; your request will be -noticed, even if it takes a while to be processed. +If you're short on time, you can also email your bug report to docs@python.org. +'docs@' is a mailing list run by volunteers; your request will be noticed, +though it may take a while to be processed. -Of course, if you want a more persistent record of your issue, you can use the -issue tracker for documentation bugs as well. +.. seealso::

+.. _using-the-tracker: Using the Python issue tracker ============================== @@ -62,9 +64,6 @@ taken on the bug. .. seealso::

- How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html> Article which goes into some detail about how to create a useful bug report. This describes what kind of information is useful and why it is useful. @@ -73,3 +72,16 @@ taken on the bug. Information about writing a good bug report. Some of this is specific to the Mozilla project, but describes general good practices. + +Getting started contributing to Python yourself +=============================================== + +Beyond just reporting bugs that you find, you are also welcome to submit +patches to fix them. You can find more information on how to get started +patching Python in the Python Developer's Guide. If you have questions, +the core-mentorship mailing list_ is a friendly place to get answers to +any and all questions pertaining to the process of fixing issues in Python. + +.. _Documentation bugs: http://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity[](#l2.51) +.. _Python Developer's Guide: http://docs.python.org/devguide/[](#l2.52) +.. _core-mentorship mailing list: https://mail.python.org/mailman/listinfo/core-mentorship/[](#l2.53)

--- a/Misc/NEWS +++ b/Misc/NEWS @@ -199,6 +199,8 @@ Tests Documentation ------------- +- Issue #20255: Update the about and bugs pages. +