Add more to Changing Python #1671
Conversation
developer-workflow/lang-changes.rst
Outdated
| Once you are certain you have a language change proposal which will appeal to | ||
| the general Python community, you can begin the PEP | ||
| process to officially propose the change. See :pep:`1` for | ||
| information on PEPs and the PEP process, and the :pep:`PEP Index <0>` for | ||
| examples. |
There was a problem hiding this comment.
Why change the wrapping here? Starting sentences/clauses on their own lines reduces future diffs, and can generally be a good idea.
There was a problem hiding this comment.
it still seems to be re-wrapped for me, as at 013d355 (#1671)
There was a problem hiding this comment.
I can't tell what you are suggesting: 1) I should change the line breaks to correspond to clauses, or 2) I shouldn't change the wrapping from the text on main? Some paragraphs have been re-wrapped already.
There was a problem hiding this comment.
My personal preference would be no uneccessary re-wrapping, but where line wrapping is required, attempt to use the "SemBr" style of wrapping, which seems to be used (at least in this para) at present.
There was a problem hiding this comment.
I understand people have different preferences, and I know we don't want gratuitous re-wrapping because it makes diffs difficult. At a quick look now, I don't see paragraphs that have been re-wrapped except where significant text has been changed.
developer-workflow/lang-changes.rst
Outdated
| - **Don't** format your idea as a Python Enhancement Proposal (*PEP*). | ||
| It's good to use the PEP template as a | ||
| guide for what information to include, but don't try to write a full PEP | ||
| until the idea has been accepted for further consideration. |
There was a problem hiding this comment.
Perhaps also add here that keeping the proposal short makes it far more likely that people will actually read it?
There was a problem hiding this comment.
I'm not sure how best to describe the right balance between brevity and detail.
There was a problem hiding this comment.
As a starter for ten?:
"Ensure your description covers all the salient points of the proposal, and make it as short as possible, but no shorter. This maximises the liklihood that other members of the community will have the time to read and consider your proposal, and is a considerate way to be respectful of their time"
There was a problem hiding this comment.
I added a bullet to the "Do" list about balancing brevity and detail.
nedbat
force-pushed
the
nedbat/how-to-change-python
branch
from
1ed273c to
013d355
Compare
developer-workflow/lang-changes.rst
Outdated
| Once you are certain you have a language change proposal which will appeal to | ||
| the general Python community, you can begin the PEP | ||
| process to officially propose the change. See :pep:`1` for | ||
| information on PEPs and the PEP process, and the :pep:`PEP Index <0>` for | ||
| examples. |
There was a problem hiding this comment.
We should be explicit here, or in the previous para, that 'support' means having a core dev willing to be the PEP's sponsor (if a PEP-sized idea), it isn't simply a lack of opposition.
| Changing Python | ||
| =============== | ||
|
|
||
| On occasion people come up with an idea for changing or improving Python. | ||
| This page explains how to propose changes and what to expect during the | ||
| process. |
There was a problem hiding this comment.
I think retaining some mention of "the Python programming language" or "Python as a programming language" would be useful here -- we're talking about ideas for the language itself, not its use or any third-party applications or libraries.
Perhaps we could even make explicit mention of this, but I don't know if that'd be overkill.
There was a problem hiding this comment.
Added. It's a little broader that just the language, but I take your point.
6 participants
This was motivated by watching the traffic in the discussion forum. I know it won't prevent simplistic proposals, but it could be a page to link to when explaining why a proposal is insufficient.
📚 Documentation preview 📚: https://cpython-devguide--1671.org.readthedocs.build/developer-workflow/lang-changes/