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.

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

Switch array-like (M, N) to (M, N) array-like. #19449

Merged
merged 1 commit into from
Feb 6, 2021

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Feb 4, 2021

Also use "array" instead of "array-like" for return types if
appropriate. Some instances were left unchanged as they may need more
editing anyways.

See discussion at #16161 (comment).

PR Summary

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).

@tacaswell tacaswell added this to the v3.4.0 milestone Feb 4, 2021

y : 2D array (M, N) or sequence of array-like (N)
y : 2D (M, N) array or sequence of (N,) array-like
Copy link
Member

@timhoffm timhoffm Feb 4, 2021

Choose a reason for hiding this comment

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

Suggested change
y : 2D (M, N) array or sequence of (N,) array-like
y : (M, N) array-like
  • 2D not needed if we have (M, N)
  • Doesn't (M, N) array-like include sequence of (N,) array-like?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes (twice)

Also use "array" instead of "array-like" for return types if
appropriate.  Some instances were left unchanged as they may need more
editing anyways.
@timhoffm timhoffm merged commit 99d19f7 into matplotlib:master Feb 6, 2021
@anntzer anntzer deleted the arraydoc branch February 6, 2021 14:00
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.

3 participants