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

Skip to content

Commit 582c0a6

Browse files
committed
Merged revisions 80388 via svnmerge from
svn+ssh://[email protected]/python/trunk ........ r80388 | georg.brandl | 2010-04-23 00:15:33 +0200 (Fr, 23 Apr 2010) | 1 line Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to [email protected]. Clarify tracker usage. ........
1 parent 445a623 commit 582c0a6

5 files changed

Lines changed: 48 additions & 13 deletions

File tree

Doc/about.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ About these documents
33
=====================
44

55

6-
These documents are generated from `reStructuredText
7-
<http://docutils.sf.net/rst.html>`_ sources by *Sphinx*, a document processor
8-
specifically written for the Python documentation.
6+
These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a
7+
document processor specifically written for the Python documentation.
8+
9+
.. _reStructuredText: http://docutils.sf.net/rst.html
10+
.. _Sphinx: http://sphinx.pocoo.org/
911

1012
.. In the online version of these documents, you can submit comments and suggest
1113
changes directly on the documentation pages.

Doc/bugs.rst

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,32 @@
11
.. _reporting-bugs:
22

3-
************************
4-
Reporting Bugs in Python
5-
************************
3+
**************
4+
Reporting Bugs
5+
**************
66

77
Python is a mature programming language which has established a reputation for
88
stability. In order to maintain this reputation, the developers would like to
99
know of any deficiencies you find in Python.
1010

11-
Bug reports should be submitted via the Python Bug Tracker
11+
12+
Documentation bugs
13+
==================
14+
15+
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.
18+
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.
21+
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.
24+
25+
26+
Using the Python issue tracker
27+
==============================
28+
29+
Bug reports for Python itself should be submitted via the Python Bug Tracker
1230
(http://bugs.python.org/). The bug tracker offers a Web form which allows
1331
pertinent information to be entered and submitted to the developers.
1432

@@ -19,9 +37,6 @@ the problem has already been fixed for the next release, or additional
1937
information is needed (in which case you are welcome to provide it if you can!).
2038
To do this, search the bug database using the search box on the top of the page.
2139

22-
In the case of documentation bugs, look at the most recent development docs at
23-
http://docs.python.org/dev to see if the bug has been fixed.
24-
2540
If the problem you're reporting is not already in the bug tracker, go back to
2641
the Python Bug Tracker and log in. If you don't already have a tracker account,
2742
select the "Register" link or, if you use OpenID, one of the OpenID provider

Doc/documenting/index.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,17 @@ should be used, as well as the Sphinx build system.
1818
.. _docutils: http://docutils.sf.net/
1919
.. _Sphinx: http://sphinx.pocoo.org/
2020

21-
If you're interested in contributing to Python's documentation, there's no need
22-
to write reStructuredText if you're not so inclined; plain text contributions
23-
are more than welcome as well.
21+
.. note::
22+
23+
If you're interested in contributing to Python's documentation, there's no
24+
need to write reStructuredText if you're not so inclined; plain text
25+
contributions are more than welcome as well. Send an e-mail to
26+
[email protected] or open an issue on the :ref:`tracker <reporting-bugs>`.
27+
2428

2529
.. toctree::
2630
:numbered:
31+
:maxdepth: 1
2732

2833
intro.rst
2934
style.rst

Doc/tools/sphinxext/indexsidebar.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,5 @@ <h3>Other resources</h3>
1919
<li><a href="http://wiki.python.org/moin/PythonBooks">Book List</a></li>
2020
<li><a href="http://www.python.org/doc/av/">Audio/Visual Talks</a></li>
2121
<li><a href="http://www.python.org/doc/other/">Other Doc Collections</a></li>
22+
<li><a href="{{ pathto('bugs') }}">Report a Bug</a></li>
2223
</ul>

Doc/tools/sphinxext/layout.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@
1616
<a href="http://www.python.org/psf/donations/">Please donate.</a>
1717
<br />
1818
Last updated on {{ last_updated|e }}.
19+
<a href="{{ pathto('bugs') }}">Found a bug</a>?
20+
<br />
1921
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version|e }}.
2022
</div>
2123
{% endblock %}
24+
{% block sidebarsourcelink %}
25+
{%- if show_source and has_source and sourcename %}
26+
<h3>{{ _('This Page') }}</h3>
27+
<ul class="this-page-menu">
28+
<li><a href="{{ pathto('bugs') }}">Report a Bug</a></li>
29+
<li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
30+
rel="nofollow">Show Source</a></li>
31+
</ul>
32+
{%- endif %}
33+
{% endblock %}

0 commit comments

Comments
 (0)