DOC: improve description of boilerplate.py #30562
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timhoffm
force-pushed
the
doc-boilerplate
branch
from
8f78b99 to
9571737
Compare
tacaswell
approved these changes
Sep 15, 2025
Member
Then what about adding a note in the API changes guide? |
story645
reviewed
Sep 15, 2025
Member
story645
left a comment
story645
left a comment
There was a problem hiding this comment.
Thanks for doing this! Minor grammar fixes and style changes.
timhoffm
force-pushed
the
doc-boilerplate
branch
from
9571737 to
49df95b
Compare
timhoffm
force-pushed
the
doc-boilerplate
branch
from
49df95b to
c85328a
Compare
story645
approved these changes
Sep 17, 2025
Member
story645
left a comment
story645
left a comment
There was a problem hiding this comment.
This is definitely an improvement, thanks!
I'd still prefer an additional note/mention in the API changes docs, but maybe in a follow up cause the where may be not obvious?
Member
Author
|
@story645 I’ll leave any potential follow up to you. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #27190.
Note: I've left out the part on adding something to the coding guidelines. The combination of the explanations in
pyplot.pyandboilerplate.pyshould be good enough to understand how this works. And the testtest_pyplot_up_to_dateshould notify any need to runboilerplate.py.I would treat this mechanism as an implementation detail that uncovers itself when needed. Adding to the coding guidelines only bloats them, but 95% of contributors will not have to know about it because they don't change our public API.