Link accepted PEPs to their whatsnew section?
I'm testing "Data Classes" for Python 3.7. Awesome new feature, BTW. The PEP is the first search result when I lookup "dataclass python". Given that the PEP is not the best documentation for an end user, I wonder if we should have a link in the header section of the PEP that goes to better documentation. We could link accepted PEPs to their section of the whatsnew. Or, link to the language documentation that describes the feature.
Google will probably fix this problem for you after dataclasses become popular. The docs will gain a bunch of inbound links and the issue will (probably) solve itself as time passes. On Tue, Jun 12, 2018 at 2:48 PM Neil Schemenauer < nas-python-ideas@arctrix.com> wrote:
On 13 June 2018 at 11:06, Michael Selik <mike@selik.org> wrote:
Sometimes when reading a PEP it isn't especially clear exactly which version it landed in, or whether or not there were significant changes post-acceptance based on issues discovered during the beta period, though. So the idea of a "Release-Note" header that points to the version specific What's New entry seems like a decent idea to me (and may actually help the What's New section supplant the PEP in search results). Cheers, Nick. -- Nick Coghlan | ncoghlan@gmail.com | Brisbane, Australia
On 2018-06-13 06:48, Nick Coghlan wrote:
I think that is a great idea. I have definitely sometimes found myself bouncing back and forth between the main documentation and the PEPs, trying to cobble together an understanding of what the actual behavior is. -- Brendan Barnwell "Do not follow where the path may lead. Go, instead, where there is no path, and leave a trail." --author unknown
On Wed, Jun 13, 2018, 06:51 Nick Coghlan <ncoghlan@gmail.com> wrote:
perhaps some machine readable format of the release tag on the PEP which is then read when generating the notes, and pulls it in? include the link to the PEP in the notes as well. just tag the PEP with release and forget about it. no idea if that fits into the process, just a thought.
Google will probably fix this problem for you after dataclasses become popular. The docs will gain a bunch of inbound links and the issue will (probably) solve itself as time passes. On Tue, Jun 12, 2018 at 2:48 PM Neil Schemenauer < nas-python-ideas@arctrix.com> wrote:
On 13 June 2018 at 11:06, Michael Selik <mike@selik.org> wrote:
Sometimes when reading a PEP it isn't especially clear exactly which version it landed in, or whether or not there were significant changes post-acceptance based on issues discovered during the beta period, though. So the idea of a "Release-Note" header that points to the version specific What's New entry seems like a decent idea to me (and may actually help the What's New section supplant the PEP in search results). Cheers, Nick. -- Nick Coghlan | ncoghlan@gmail.com | Brisbane, Australia
On 2018-06-13 06:48, Nick Coghlan wrote:
I think that is a great idea. I have definitely sometimes found myself bouncing back and forth between the main documentation and the PEPs, trying to cobble together an understanding of what the actual behavior is. -- Brendan Barnwell "Do not follow where the path may lead. Go, instead, where there is no path, and leave a trail." --author unknown
On Wed, Jun 13, 2018, 06:51 Nick Coghlan <ncoghlan@gmail.com> wrote:
perhaps some machine readable format of the release tag on the PEP which is then read when generating the notes, and pulls it in? include the link to the PEP in the notes as well. just tag the PEP with release and forget about it. no idea if that fits into the process, just a thought.
participants (5)
-
Brendan Barnwell -
Matt Arcidy -
Michael Selik -
Neil Schemenauer -
Nick Coghlan