-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Getting Started GSoD #19183
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
base: main
Are you sure you want to change the base?
Getting Started GSoD #19183
Conversation
superscedes #18873 |
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.
One thing missing from the implicit discussion is what 'automatic'/'implicit' means. As far as I could find, nothing seems to define what that means or delve into the concept of a current Figure/Axes. This makes the 'automatic'/'implicit' terms very vague and a bit magic.
5e3fcdb
to
3e69f1d
Compare
166ae54
to
6ead780
Compare
e8c677c
to
24e667f
Compare
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.
This review only adresses the style guide part to keep it more managable. It's possibly easier not not mix this with the getting started guide.
Usually, I would split the two aspects in separate PRs, but I acknowledge that git is not easy to use and I want to save @jeromefv the hassle of extracting parts from this PR. Threrefore I propose to first discuss the style guide and do the getting started guide afterwards.
24e667f
to
0502094
Compare
0502094
to
5243695
Compare
57649f9
to
fac20cd
Compare
A few comments on the Usage Guide. I'm not sure its effective to switch between the "implicit" and "explicit" interface. It really interrupts the flow particularly when you explain the differences between the two quite a few times. I think maybe someone thought this would make it easier for people to transition between the two interfaces? But if it were me, I'd just write a separate tutorial for that. I found it quit bizarre to go from line plots to a loving set of examples using pie charts of various complexities. That seems very out of place, and I don't understand what its doing there at all. If I were in charge of this project, I'd
|
So I think @jklymak is making great suggestions, and if were starting from scratch would probably go that way, but I'm also not sure it should hold up this PR? |
I think the style guide is an improvement. I'm not convinced that the usage guide is. |
I agree with @jklymak. I propose to merge the style guide part now and meditate on the usage guide separately. |
Happy to get the Documentation Style Guide in, though I'm not sure how to separate it from this PR. Originally, this project could have gone the route of two separate PRs, but I think for GSoD 2020 we went with the one for convenience. As for the Getting Started guide, changes at that scale would take some time to unpack from its current state. That would likely be easier once the Style Guide is its own PR. Happy to take guidance on next steps for this! I'm excited to see how it all turns out! Thanks everyone! |
* Fixed reference to Anatomy of a figure
and style guide additions
added link to Python docs
changed style_guide.rst
correct/incorrect for Figure, Axes, Artist, Axis
Just make a fresh branch from master and copy the new file and add it, commit, and make a new PR. |
Since this Pull Request has not been updated in 60 days, it has been marked "inactive." This does not mean that it will be closed, though it may be moved to a "Draft" state. This helps maintainers prioritize their reviewing efforts. You can pick the PR back up anytime - please ping us if you need a review or guidance to move the PR forward! If you do not plan on continuing the work, please let us know so that we can either find someone to take the PR over, or close it. |
Organisational remark: The style guide part is merged. And is the one producing the conflicts. It can be removed to put this in a clean state. I haven't look at the tutorial part and thus cannot comment whether it's worth reviving that. |
I think there's some good explanatory stuff there that might be worth integrating with the current guide, but the cleanest thing will likely be to open a new PR w/ @jeromefv as a coauthor. |
PR Summary
Documentation for Google Season of Docs (GSoD) 2020 with Matplotlib.
Getting Started
This document introduces basic and fundamental concepts for Matplotlib as a supplement for the current Usage Guide. The introductory tutorial focuses on key differences between Explicit (OOP) and Implicit (
pyplot
) strategies for developing visuals with Matplotlib.Style Guide
In addition, I have included a lean Style Guide as a reference for documentation best practices. This section provides a resource for writing standards across all documentation.
PR Checklist
pytest
passes).flake8
on changed files to check).flake8-docstrings
and runflake8 --docstring-convention=all
).doc/users/next_whats_new/
(follow instructions in README.rst there).doc/api/next_api_changes/
(follow instructions in README.rst there).