Skip to content

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

Draft
wants to merge 25 commits into
base: main
Choose a base branch
from
Draft

Getting Started GSoD #19183

wants to merge 25 commits into from

Conversation

jeromefv
Copy link
Contributor

@jeromefv jeromefv commented Dec 28, 2020

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

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@story645
Copy link
Member

superscedes #18873

Copy link
Member

@QuLogic QuLogic left a 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.

@jeromefv jeromefv force-pushed the getting_started branch 2 times, most recently from 5e3fcdb to 3e69f1d Compare January 21, 2021 01:03
@jeromefv jeromefv force-pushed the getting_started branch 2 times, most recently from 166ae54 to 6ead780 Compare February 1, 2021 17:49
@jklymak jklymak modified the milestones: v3.4.0, v3.4-doc Feb 4, 2021
Copy link
Member

@timhoffm timhoffm left a 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.

@jklymak
Copy link
Member

jklymak commented May 11, 2021

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

  1. break this into two PRs! Because I suspect the style guide is "fine"/could be polished in follow ups
  2. greatly simplify the "Usage Guide" and take out the pyplot stuff except to point towards somewhere we explain the difference.
  3. If there is no where we explain the difference, write that as a different page, perhaps with an automatically generated large table that points out where the pyplot methods come from in the OO interface?

@story645
Copy link
Member

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?

@jklymak
Copy link
Member

jklymak commented May 12, 2021

I think the style guide is an improvement. I'm not convinced that the usage guide is.

@timhoffm
Copy link
Member

I agree with @jklymak. I propose to merge the style guide part now and meditate on the usage guide separately.

@jeromefv
Copy link
Contributor Author

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!

@jklymak
Copy link
Member

jklymak commented May 13, 2021

Just make a fresh branch from master and copy the new file and add it, commit, and make a new PR.

@jklymak jklymak marked this pull request as draft May 14, 2021 14:51
@QuLogic QuLogic modified the milestones: v3.4-doc, v3.5-doc Nov 16, 2021
@oscargus oscargus modified the milestones: v3.5-doc, v3.6-doc Sep 25, 2022
@QuLogic QuLogic modified the milestones: v3.6-doc, v3.7.0 Jan 11, 2023
@tacaswell tacaswell modified the milestones: v3.7.0, v3.8.0 Jan 11, 2023
@ksunden ksunden modified the milestones: v3.8.0, future releases Aug 8, 2023
Copy link

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.

@github-actions github-actions bot added the status: inactive Marked by the “Stale” Github Action label Nov 13, 2023
@timhoffm
Copy link
Member

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.

@story645
Copy link
Member

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.

@github-actions github-actions bot removed the status: inactive Marked by the “Stale” Github Action label Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants