Skip to content

Improve Locator docstrings#27686

Merged
dstansby merged 2 commits intomatplotlib:mainfrom
dstansby:locator-docstrings
Jan 30, 2024
Merged

Improve Locator docstrings#27686
dstansby merged 2 commits intomatplotlib:mainfrom
dstansby:locator-docstrings

Conversation

@dstansby
Copy link
Copy Markdown
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
Copy link
Copy Markdown
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.

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.

@dstansby dstansby marked this pull request as ready for review January 23, 2024 09:35
@dstansby
Copy link
Copy Markdown
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.

Copy link
Copy Markdown
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?

@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
Copy Markdown
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
@dstansby
Copy link
Copy Markdown
Member Author

👍 to squash merging

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants