-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
PEP 11: Add Discussions section #2544
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
@brettcannon @corona10: Here is a PR to add references to recent discussions. |
I dislike Post-History header. IMO it's not well rendered, so hard to read, and the format disallow to add much info (discussion title, first author name, etc.). I prefer to omit the day, only mention the month+year. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, but let's wait Brett :)
Adding a section listing the discussions that led to the PEP and drove its evolution is great, of course, and what I also recommended in #2538 (although it would have been arguably been even more beneficial to provide a bit of context summarizing each discussions and mentioning what actually changed in the PEP because of them, beyond just repeating the thread name, date and author shown at the top of the linked page). However, I'm afraid I don't quite understand why it was necessary to completely remove the existing I opened # to restore and update it, including the relevant direct links @vstinner helpfully dug up, while of course retaining the inline
Could you please open an issue articulating your specific concerns and what you propose changing ? For reference, I implemented current format was requested on #2335 by multiple people, discussed and documented in #2266 and as a followup to PR #2346 , where it was also independently requested by another reviewer, discussed at length and implemented in #2358 , part of the changes approved by the Steering Council in python/steering-council#113 , part of the experimental public API added in #2475 , with the rendering further improved in #2467 and validation added in #2484 . While a lot has gone into the current header rendering, there's always room to evolve further, of course. After all, if not for the constructive feedback of PEP authors and others,
Okay, so can you describe the specific problems you've found with the rendering so we can fix them?
Would you mind explaining what makes it hard to read, so we can improve it?
The
The fact that the |
Why do you want to make it even harder to write a PEP? The formalism is already really high. Post-History is a list of date: it doesn't mention on which list the message was sent, and it became really hard to find a message from a date in Mailman 3 which shows the date of the latest message, not the first message. Today, PEPs are discussed in many places:
You cannot simply give a list of dates. If PEP 1 and PEP 12 disallow that, I suggest to fix these PEPs instead. Before my change, the headers were:
It doesn't say where the PEP was discussed. Did you try to find the related emails from these dates? |
We recently changed Post-History to allow links. See PEP-681 for an example. That format would work here too, though your PR adds some more useful detail, like the thread names. |
@vstinner I think there may be a miscommunication between us, sorry, because I thought you were taking about the new format and automatic parsing I just implemented, and it sounds like you thought I was talking about the old format, but it sounds like we are in fact in violent agreement 😄 Just like you, for the same reasons you aptly describe, I also found it very hard to unambiguously find the right thread or message with just the date, making the legacy Additionally, now that I implemented #2467 , the posting venue and type ( You can check out how this looks for this PEP in the source and in the output on #2546 . This also works for
Yeah, though thanks in large part to your harder work doing it already :D In fact, I was confused by the fact that the 2015 "post" originally listed under |
IMO, PEP editors are the ones interested in these details of keeping the PEPs organized (which increasingly includes automation as well, so human readers aren't the only audience). But it shouldn't be hard for the PEP author.
You can file an issue/PR with the proposal. But be prepared for some nitpicky discussion, and don't assume you know all the background. |
I don't think that a closed PR is a good place to discuss the "Discussions" section, so I created #2560 instead. |
No description provided.