Skip to content
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

Improve Locator docstrings #27686

Merged
merged 2 commits into from
Jan 30, 2024
Merged

Improve Locator docstrings #27686

merged 2 commits into from
Jan 30, 2024

Conversation

dstansby
Copy link
Member

PR summary

Improves Locator docstrings by adding a single sentence at the beginning of each docstring in a consistent style.

PR checklist

@dstansby dstansby added the Documentation: API files in lib/ and doc/api label Jan 22, 2024
story645
story645 requested changes Jan 22, 2024
View reviewed changes
Copy link
Member

@story645 story645 left a comment •
edited

Choose a reason for hiding this comment

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

Like the uniformity a lot, but think Places/positions ticks would be clearer.

Everything else is mostly various shades of small comments.

Also 🤦‍♀️ and apologies if draft meant this wasn't ready for review.

lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
@dstansby dstansby marked this pull request as ready for review January 23, 2024 09:35
@dstansby
Copy link
Member Author

Also 🤦‍♀️ and apologies if draft meant this wasn't ready for review.

No a review is very welcome 😄 - I tend to open PRs in draft until the CI passes just in case.

story645
story645 approved these changes Jan 24, 2024
View reviewed changes
Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

mostly nits, but maybe linearly spaced->evenly spaced for clarity?

lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
lib/matplotlib/ticker.py Outdated Show resolved Hide resolved
@github-actions github-actions bot removed the Documentation: API files in lib/ and doc/api label Jan 30, 2024
@story645 story645 added this to the v3.9.0 milestone Jan 30, 2024
@story645 story645 added the Documentation: API files in lib/ and doc/api label Jan 30, 2024
@story645
Copy link
Member

Can I squash merge (or you can squash merge) or do you want to rebase?

@dstansby dstansby merged commit d3144b1 into matplotlib:main Jan 30, 2024
39 of 45 checks passed
@dstansby
Copy link
Member Author

👍 to squash merging

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuLogic QuLogic QuLogic left review comments

@story645 story645 story645 approved these changes

Assignees
No one assigned
Labels
Documentation: API files in lib/ and doc/api topic: ticks axis labels
Projects
None yet
Milestone
v3.9.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@dstansby @story645 @QuLogic