DOC: consolidated coding guide and added naming conventions table#27213
Merged
timhoffm merged 1 commit intomatplotlib:mainfrom Nov 3, 2023
Merged
DOC: consolidated coding guide and added naming conventions table#27213timhoffm merged 1 commit intomatplotlib:mainfrom
timhoffm merged 1 commit intomatplotlib:mainfrom
Conversation
87cf806 to
cce1ac6
Compare
story645
commented
Oct 27, 2023
cce1ac6 to
4a4496a
Compare
4a4496a to
1e827d5
Compare
f9f7f62 to
3c5e164
Compare
Member
Author
|
Attn @timhoffm - I moved things around so much that I figure I should check if I did anything you're opposed to. |
11 tasks
a3514c7 to
5cb6344
Compare
tacaswell
reviewed
Oct 31, 2023
3bce52d to
c5eb7a2
Compare
c5eb7a2 to
71f4a4e
Compare
c0033f6 to
57f5908
Compare
Member
Thanks for the heads up. I will check later. |
1 task
timhoffm
reviewed
Nov 2, 2023
d690302 to
e12c7db
Compare
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
e12c7db to
5143bad
Compare
timhoffm
approved these changes
Nov 3, 2023
Member
|
@story645 please decide yourself whether you want to backport this. |
Member
Author
|
@meeseeksdev backport to v3.8-doc |
|
Something went wrong ... Please have a look at my logs. It seems that the branch you are trying to backport to does not exist. |
Member
Author
|
@meeseeksdev backport to v3.8.x |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Nov 3, 2023
…d naming conventions table
Member
Author
|
@meeseeksdev backport to v3.8.1-doc |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Nov 3, 2023
…d naming conventions table
Member
Author
|
backported to avoid merge conflicts if smaller changes get backported 😓 |
story645
added a commit
that referenced
this pull request
Nov 3, 2023
…213-on-v3.8.x Backport PR #27213 on branch v3.8.x (DOC: consolidated coding guide and added naming conventions table)
story645
added a commit
that referenced
this pull request
Nov 3, 2023
…213-on-v3.8.1-doc Backport PR #27213 on branch v3.8.1-doc (DOC: consolidated coding guide and added naming conventions table)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This started as an attempt to document variable naming conventions to address #22156 and well trying to put a table into a bullet list didn't work well and that had me thinking that a bullet list is the wrong structure when tables are involved so 😅 this PR:
While it may not seem like it, I have tried to avoid rewording/rewriting except to remove redundancy. In particularly, I'm trying to remove duplicate sets of detailed instructions b/c I think that creates space for deviation in those instructions/confusion.
Next Steps
I think merging this should be good enough to close #26095 cause it'll at least put everything in one place (mostly). I don't want to overwhelm this PR w/ changes since it's already doing a lot more than I planned, but once this is merged I'd like to clean up the code section of the policy and guidelines page so that it can just be a TOC. To do so, I think a sensible swapping would be to
Basically proposing that the code section of policies & guidelines changes:
and the triage section changes to
or the pull request triage document gets moved to maintenance, but technically I think anyone w/ triage rights can do most of the triage stuff discussed in the pull request guide.