Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org. Clarify tracker usage.
This commit is contained in:
parent
9aed604fb2
commit
e11d85c717
|
@ -3,9 +3,11 @@ About these documents
|
|||
=====================
|
||||
|
||||
|
||||
These documents are generated from `reStructuredText
|
||||
<http://docutils.sf.net/rst.html>`_ sources by *Sphinx*, a document processor
|
||||
specifically written for the Python documentation.
|
||||
These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a
|
||||
document processor specifically written for the Python documentation.
|
||||
|
||||
.. _reStructuredText: http://docutils.sf.net/rst.html
|
||||
.. _Sphinx: http://sphinx.pocoo.org/
|
||||
|
||||
.. In the online version of these documents, you can submit comments and suggest
|
||||
changes directly on the documentation pages.
|
||||
|
|
29
Doc/bugs.rst
29
Doc/bugs.rst
|
@ -1,14 +1,32 @@
|
|||
.. _reporting-bugs:
|
||||
|
||||
************************
|
||||
Reporting Bugs in Python
|
||||
************************
|
||||
**************
|
||||
Reporting Bugs
|
||||
**************
|
||||
|
||||
Python is a mature programming language which has established a reputation for
|
||||
stability. In order to maintain this reputation, the developers would like to
|
||||
know of any deficiencies you find in Python.
|
||||
|
||||
Bug reports should be submitted via the Python Bug Tracker
|
||||
|
||||
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.
|
||||
|
||||
docs@python.org is a mailing list run by volunteers; your request will be
|
||||
noticed, even if it takes 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.
|
||||
|
||||
|
||||
Using the Python issue tracker
|
||||
==============================
|
||||
|
||||
Bug reports for Python itself should be submitted via the Python Bug Tracker
|
||||
(http://bugs.python.org/). The bug tracker offers a Web form which allows
|
||||
pertinent information to be entered and submitted to the developers.
|
||||
|
||||
|
@ -19,9 +37,6 @@ the problem has already been fixed for the next release, or additional
|
|||
information is needed (in which case you are welcome to provide it if you can!).
|
||||
To do this, search the bug database using the search box on the top of the page.
|
||||
|
||||
In the case of documentation bugs, look at the most recent development docs at
|
||||
http://docs.python.org/dev to see if the bug has been fixed.
|
||||
|
||||
If the problem you're reporting is not already in the bug tracker, go back to
|
||||
the Python Bug Tracker and log in. If you don't already have a tracker account,
|
||||
select the "Register" link or, if you use OpenID, one of the OpenID provider
|
||||
|
|
|
@ -18,12 +18,17 @@ should be used, as well as the Sphinx build system.
|
|||
.. _docutils: http://docutils.sf.net/
|
||||
.. _Sphinx: http://sphinx.pocoo.org/
|
||||
|
||||
If you're interested in contributing to Python's documentation, there's no need
|
||||
to write reStructuredText if you're not so inclined; plain text contributions
|
||||
are more than welcome as well.
|
||||
.. note::
|
||||
|
||||
If you're interested in contributing to Python's documentation, there's no
|
||||
need to write reStructuredText if you're not so inclined; plain text
|
||||
contributions are more than welcome as well. Send an e-mail to
|
||||
docs@python.org or open an issue on the :ref:`tracker <reporting-bugs>`.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:numbered:
|
||||
:maxdepth: 1
|
||||
|
||||
intro.rst
|
||||
style.rst
|
||||
|
|
|
@ -19,4 +19,5 @@
|
|||
<li><a href="http://wiki.python.org/moin/PythonBooks">Book List</a></li>
|
||||
<li><a href="http://www.python.org/doc/av/">Audio/Visual Talks</a></li>
|
||||
<li><a href="http://www.python.org/doc/other/">Other Doc Collections</a></li>
|
||||
<li><a href="{{ pathto('bugs') }}">Report a Bug</a></li>
|
||||
</ul>
|
||||
|
|
|
@ -16,6 +16,18 @@
|
|||
<a href="http://www.python.org/psf/donations/">Please donate.</a>
|
||||
<br />
|
||||
Last updated on {{ last_updated|e }}.
|
||||
<a href="{{ pathto('bugs') }}">Found a bug</a>?
|
||||
<br />
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version|e }}.
|
||||
</div>
|
||||
{% endblock %}
|
||||
{% block sidebarsourcelink %}
|
||||
{%- if show_source and has_source and sourcename %}
|
||||
<h3>{{ _('This Page') }}</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="{{ pathto('bugs') }}">Report a Bug</a></li>
|
||||
<li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
{%- endif %}
|
||||
{% endblock %}
|
||||
|
|
Loading…
Reference in New Issue