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.

Author fdrake
Recipients Mariatta, Paul Hammant, docs@python, fdrake
Date 2017-07-27.19:01:57
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <CAFT4OTFshxo_OAo5jFKAgXQbd+Oe0Fupc-rj3nVwhLyMzhu2hQ@mail.gmail.com>
In-reply-to <1501175001.75.0.253826202483.issue31055@psf.upfronthosting.co.za>
Content
On Thu, Jul 27, 2017 at 1:03 PM, Mariatta Wijaya <report@bugs.python.org> wrote:
> I don't think we should add this link.
>
> When we make edits to the docs, even simple typo fixes, it should first be done
> in the master branch, instead of the maintenance branches (e.g. 2.7, 3.5 or 3.6).
>
> If "Edit This Page" link takes you to edit the documentation in branches other
> than "master", that's not desirable workflow.
>
> If "Edit This Page" link takes you to edit the master branch, it can be confusing
> to the contributor since the content on "master" might be different.

I wonder if a better solution lies somewhere between the original
suggestion and just
not including such a link.

If the link went to an edit form with the version of the content the
user was reading,
and includes an explanation of the multiple-versions issue, it might
prove reasonable
to try applying the diff between the modified and original text to the
HEADs of each
maintenance branch.  If the diff doesn't apply, the (possibly new)
contributor can be
offered a chance to deal with edits to each version (which might be a bit much).

At any rate, the diff could be used to construct a temporary branch,
b.p.o issue, and
PR. This would allow us to provide the contributor with a way to see
that their suggested
changes are being considered, and we're less likely to lose them in a
wall of email.

There'd be a bit of work to make all this play out, though.

  -Fred
History
Date User Action Args
2017-07-27 19:01:58fdrakesetrecipients: + fdrake, Paul Hammant, Mariatta
2017-07-27 19:01:57fdrakelinkissue31055 messages
2017-07-27 19:01:57fdrakecreate