IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update bug reporting page for roundup.

Browse Source
This commit is contained in:
Georg Brandl 2007-08-08 07:33:11 +00:00
parent 52a7637cfd
commit 67e2e52af5
2 changed files with 50 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
Doc-26/bugs.rst
View File

@ -1,46 +1,47 @@
.. _reporting-bugs:
**************
Reporting Bugs
**************
************************
Reporting Bugs in Python
************************
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 or its documentation.
know of any deficiencies you find in Python.
Before submitting a report, you will be required to log into SourceForge; this
will make it possible for the developers to contact you for additional
information if needed. It is not possible to submit a bug report anonymously.
If you find errors in the documentation, please use either the "Add a comment"
or the "Suggest a change" features of the relevant page in the most recent
online documentation at http://docs.python.org/.
All bug reports should be submitted via the Python Bug Tracker on SourceForge
(http://sourceforge.net/bugs/?group_id=5470). The bug tracker offers a Web form
which allows pertinent information to be entered and submitted to the
developers.
All other bug reports 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.
The first step in filing a report is to determine whether the problem has
already been reported. The advantage in doing so, aside from saving the
developers time, is that you learn what has been done to fix it; it may be that
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 left side of the
page.
To do this, search the bug database using the search box on the top of the page.
If the problem you're reporting is not already in the bug tracker, go back to
the Python Bug Tracker (http://sourceforge.net/bugs/?group_id=5470). Select the
"Submit a Bug" link at the top of the page to open the bug reporting form.
the Python Bug Tracker. If you don't already have a tracker account, select the
"Register" link in the sidebar and undergo the registration procedure.
Otherwise, if you're not logged in, enter your credentials and select "Login".
It is not possible to submit a bug report anonymously.
The submission form has a number of fields. The only fields that are required
are the "Summary" and "Details" fields. For the summary, enter a *very* short
description of the problem; less than ten words is good. In the Details field,
describe the problem in detail, including what you expected to happen and what
did happen. Be sure to include the version of Python you used, whether any
Being now logged in, you can submit a bug. Select the "Create New" link in the
sidebar to open the bug reporting form.
The submission form has a number of fields. For the "Title" field, enter a
*very* short description of the problem; less than ten words is good. In the
"Type" field, select the type of your problem; also select the "Component" and
"Versions" to which the bug relates.
In the "Change Note" field, describe the problem in detail, including what you
expected to happen and what did happen. Be sure to include whether any
extension modules were involved, and what hardware and software platform you
were using (including version information as appropriate).
The only other field that you may want to set is the "Category" field, which
allows you to place the bug report into a broad category (such as
"Documentation" or "Library").
Each bug report will be assigned to a developer who will determine what needs to
be done to correct the problem. You will receive an update each time action is
taken on the bug.

49
Doc-3k/bugs.rst
View File

@ -1,46 +1,47 @@
.. _reporting-bugs:
**************
Reporting Bugs
**************
************************
Reporting Bugs in Python
************************
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 or its documentation.
know of any deficiencies you find in Python.
Before submitting a report, you will be required to log into SourceForge; this
will make it possible for the developers to contact you for additional
information if needed. It is not possible to submit a bug report anonymously.
If you find errors in the documentation, please use either the "Add a comment"
or the "Suggest a change" features of the relevant page in the most recent
online documentation at http://docs.python.org/.
All bug reports should be submitted via the Python Bug Tracker on SourceForge
(http://sourceforge.net/bugs/?group_id=5470). The bug tracker offers a Web form
which allows pertinent information to be entered and submitted to the
developers.
All other bug reports 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.
The first step in filing a report is to determine whether the problem has
already been reported. The advantage in doing so, aside from saving the
developers time, is that you learn what has been done to fix it; it may be that
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 left side of the
page.
To do this, search the bug database using the search box on the top of the page.
If the problem you're reporting is not already in the bug tracker, go back to
the Python Bug Tracker (http://sourceforge.net/bugs/?group_id=5470). Select the
"Submit a Bug" link at the top of the page to open the bug reporting form.
the Python Bug Tracker. If you don't already have a tracker account, select the
"Register" link in the sidebar and undergo the registration procedure.
Otherwise, if you're not logged in, enter your credentials and select "Login".
It is not possible to submit a bug report anonymously.
The submission form has a number of fields. The only fields that are required
are the "Summary" and "Details" fields. For the summary, enter a *very* short
description of the problem; less than ten words is good. In the Details field,
describe the problem in detail, including what you expected to happen and what
did happen. Be sure to include the version of Python you used, whether any
Being now logged in, you can submit a bug. Select the "Create New" link in the
sidebar to open the bug reporting form.
The submission form has a number of fields. For the "Title" field, enter a
*very* short description of the problem; less than ten words is good. In the
"Type" field, select the type of your problem; also select the "Component" and
"Versions" to which the bug relates.
In the "Change Note" field, describe the problem in detail, including what you
expected to happen and what did happen. Be sure to include whether any
extension modules were involved, and what hardware and software platform you
were using (including version information as appropriate).
The only other field that you may want to set is the "Category" field, which
allows you to place the bug report into a broad category (such as
"Documentation" or "Library").
Each bug report will be assigned to a developer who will determine what needs to
be done to correct the problem. You will receive an update each time action is
taken on the bug.