8000 Cleanup parameter types in docstrings by timhoffm · Pull Request #17309 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Cleanup parameter types in docstrings #17309

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 1 commit into from
May 3, 2020
Merged

Cleanup parameter types in docstrings #17309

merged 1 commit into from
May 3, 2020

Conversation

timhoffm
Copy link
Member
@timhoffm timhoffm commented May 3, 2020

PR Summary

According to https://matplotlib.org/devdocs/devel/documenting_mpl.html#parameter-type-descriptions; in particular

  • scalar -> float or int
  • sequence of scalar -> array-like

anntzer
anntzer reviewed May 3, 2020
View reviewed changes
anntzer
anntzer approved these changes May 3, 2020
View reviewed changes
Copy link
Contributor
@anntzer anntzer left a comment

Choose a reason for hiding this comment

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

one minor point, can self-merge after fixing that

@timhoffm timhoffm added this to the v3.3.0 milestone May 3, 2020
@timhoffm timhoffm merged commit 8bbff6d into matplotlib:master May 3, 2020
@timhoffm timhoffm deleted the doc-scalar branch May 3, 2020 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anntzer anntzer anntzer approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.3.0
Development

Successfully merging this pull request may close these issues.
2 participants
@timhoffm @anntzer
0