This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: "Suggest a change" link
Type: Stage:
Components: Documentation Versions: Python 2.7
Status: closed Resolution: out of date
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: ajaksu2, ezio.melotti, georg.brandl, techtonik
Priority: low Keywords:

Created on 2008-07-11 11:10 by techtonik, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (13)
msg69544 - (view) Author: anatoly techtonik (techtonik) Date: 2008-07-11 11:10
It would be convenient to have "Suggest a change" link in the bottom of
documentation pages to allow people propose fixes and additions. 

This can be a simple feedback form with an optional "patch" field that
submits mail to a list or simply adds documentation comment.

More complex approach would be construct patch right in the browser.
Then add it for review into "documentation queue". "documentation queue"
is a part of documentation system to automatically submit patches after
review (and optionally incrementally-recompile existing output formats).
In case of page comments review status can be displayed in place
together with comments and patches. The whole edit/review process may
require single sign on system described in issue #2837
msg69834 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-07-16 21:06
Yes, this is under consideration.
msg69875 - (view) Author: anatoly techtonik (techtonik) Date: 2008-07-17 06:30
Any links to alpha code?
msg69927 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-07-17 23:22
None yet. :(
msg90526 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2009-07-14 23:34
An easier approach would be to open the "create a new issue" page of the
tracker when the user clicks on "suggest a change".
The title can be set automatically to something like "Doc suggestion on
Page XYZ". The "Documentation" component and the version could be set
automatically too, and the "Comment" field could include a link to the page.
If the user is registered to the tracker, he would just have to write
the comment and submit, possibly changing/adjusting the fields.

I don't know if it's actually possible to do something like this, but it
shouldn't be too hard to hack the tracker in order to pass this
information when the users click on the link.
msg90560 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-07-16 07:35
Since this will be handled by Sphinx, it is not an issue for this tracker.
msg97999 - (view) Author: anatoly techtonik (techtonik) Date: 2010-01-18 09:28
This functionality is specific request for python documentation, so adjustments should be made to Sphinx customization layer for if Sphinx itself doesn't provide such feature.

Is there a bug tracker for infrastructure?
msg104081 - (view) Author: anatoly techtonik (techtonik) Date: 2010-04-24 12:57
I am glad there is some response to this issue in r80388
msg104084 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-04-24 13:06
I'm closing this again; I can see that nobody will implement this for Python if it's not available in Sphinx, and also I don't think it would be a good idea to do so.
msg104089 - (view) Author: anatoly techtonik (techtonik) Date: 2010-04-24 13:16
Georg, if you are not going to implement it, it doesn't mean nobody will do this. In Sphinx or through disqus. I do not see the reason to close this feature request.

Also I do not understand arguments like:
"Yes, this is under consideration." in msg69834 and
"I don't think it would be a good idea to do so." in msg104084

Care to explain why you have changed your mind?
msg104090 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-04-24 13:22
I haven't changed my mind.  The "it would not be a good idea to do so" refers to implementing this for Python exclusively.

Of course, if you volunteer to do so, I won't stop you :)  Otherwise, please trust my judgement that this issue will do nothing except eventually be closed again due to lack of movement, or because something has been implemented in Sphinx.  It may even be during this year's Summer of Code, if we're lucky.
msg126660 - (view) Author: anatoly techtonik (techtonik) Date: 2011-01-20 23:21
Still actual, esp. with this - and this
msg126699 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2011-01-21 07:07
And still this is a thing that Sphinx needs to do (already does, but needs to be finalized.)
Date User Action Args
2022-04-11 14:56:36adminsetgithub: 47591
2011-01-21 07:07:24georg.brandlsetstatus: open -> closed
nosy: georg.brandl, techtonik, ajaksu2, ezio.melotti
messages: + msg126699
2011-01-20 23:21:39techtoniksetstatus: closed -> open
nosy: georg.brandl, techtonik, ajaksu2, ezio.melotti
messages: + msg126660
2010-04-24 13:22:05georg.brandlsetmessages: + msg104090
2010-04-24 13:16:41techtoniksetmessages: + msg104089
2010-04-24 13:16:32georg.brandllinkissue2823 superseder
2010-04-24 13:06:13georg.brandlsetmessages: + msg104084
2010-04-24 13:00:36georg.brandlsetstatus: open -> closed
2010-04-24 12:57:23techtoniksetmessages: + msg104081
versions: + Python 2.7
2010-01-18 09:28:25techtoniksetstatus: closed -> open

messages: + msg97999
2009-07-16 07:35:02georg.brandlsetstatus: open -> closed
resolution: out of date
messages: + msg90560
2009-07-14 23:34:02ezio.melottisetpriority: low
nosy: + ajaksu2, ezio.melotti
messages: + msg90526

2008-07-17 23:22:05georg.brandlsetmessages: + msg69927
2008-07-17 06:30:24techtoniksetmessages: + msg69875
2008-07-16 21:06:00georg.brandlsetmessages: + msg69834
2008-07-11 11:10:08techtonikcreate