8000 Fix typo in Quick start guide tutorial by Dusch4593 · Pull Request #25519 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Fix typo in Quick start guide tutorial #25519

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 22, 2023
Merged

Fix typo in Quick start guide tutorial #25519

merged 2 commits into from
Mar 22, 2023

Conversation

Dusch4593
Copy link
Contributor
@Dusch4593 Dusch4593 commented Mar 21, 2023 •
edited
Loading

PR Summary

Fixes a typo in the code block under the Figure section of the "Quick start guide" by adding a closing single quote mark ' after right_bottom.

#    fig, axs = plt.subplot_mosaic([['left', 'right-top'],
#                                   ['left', 'right_bottom]])
#                                   ['left', 'right_bottom']])

P.S. Is there a reason why there is a dash in right-top and an underscore in right_bottom?

PR Checklist

Documentation and Tests

  • [N/A] Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • [N/A] New plotting related features are documented with examples.

Release Notes

  • [N/A] New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • [N/A] API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • [N/A] Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

github-actions[bot]
github-actions bot reviewed Mar 21, 2023
View reviewed changes
Copy link
@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

@jklymak
Copy link
Member
jklymak commented Mar 21, 2023

No there is no reason for the inconsistent names. I'm surprised this worked at all. Thanks for catching it.

@QuLogic
Copy link
Member
QuLogic commented Mar 21, 2023

No there is no reason for the inconsistent names. I'm surprised this worked at all. Thanks for catching it.

The code there is a code block for display only, so there was nothing to break. Also, the names don't matter and are purely for the user to access, so it doesn't matter for Matplotlib that there's some inconsistency there. But we should probably change it for consistency.

jklymak
jklymak reviewed Mar 21, 2023
View reviewed changes
@Dusch4593 @jklymak
Update galleries/users_explain/quick_start.py
d9e2c4b 
Co-authored-by: Jody Klymak <jklymak@gmail.com>
@tacaswell tacaswell added this to the v3.7-doc milestone Mar 22, 2023
@tacaswell tacaswell merged commit 5ed2b3f into matplotlib:main Mar 22, 2023
@tacaswell
Copy link
Member
tacaswell commented Mar 22, 2023 •
edited
Loading

Thank you @Dusch4593 and congratulations on your first merged Matplotlib PR 🎉 Hope we hear from you again!

@meeseeksmachine meeseeksmachine mentioned this pull request Mar 22, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 22, 2023
@tacaswell @meeseeksmachine
Backport PR matplotlib#25519: Fix typo in Quick start guide tutorial
f44e3af
@meeseeksmachine meeseeksmachine mentioned this pull request Mar 22, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 22, 2023
@tacaswell @meeseeksmachine
Backport PR matplotlib#25519: Fix typo in Quick start guide tutorial
f320aa3
@Dusch4593
Copy link
Contributor Author

Thanks @tacaswell! Am I good to delete the PR branch on my end? (fix-typo-in-quick-start)

@tacaswell
Copy link
Member

Yes, those commits are now in the Matplotlib main branch and your branch (which is just a pointer to the commits) is no longer needed.

See https://tacaswell.github.io/think-like-git.html for lots more details.

@Dusch4593 Dusch4593 deleted the fix-typo-in-quick-start branch March 22, 2023 12:57
rcomer added a commit that referenced this pull request Mar 22, 2023
@rcomer
Merge pull request #25528 from meeseeksmachine/auto-backport-of-pr-25…
2f25614 
…519-on-v3.7.x

Backport PR #25519 on branch v3.7.x (Fix typo in Quick start guide tutorial)
rcomer added a commit that referenced this pull request Mar 22, 2023
@rcomer
Merge pull request #25529 from meeseeksmachine/auto-backport-of-pr-25…
b8d949e 
…519-on-v3.7.1-doc

Backport PR #25519 on branch v3.7.1-doc (Fix typo in Quick start guide tutorial)
@tacaswell tacaswell mentioned this pull request Jul 14, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jklymak jklymak jklymak left review comments

@github-actions github-actions[bot] github-actions[bot] left review comments

@tacaswell tacaswell tacaswell approved these changes

Assignees
No one assigned
Labels
None yet
Projects
First Time Contributors
Status: Done
Milestone
v3.7-doc
Development

Successfully merging this pull request may close these issues.
4 participants
@Dusch4593 @jklymak @QuLogic @tacaswell
0