Skip to content

atleast_2d documentation #8214

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
Closed
mattharrigan opened this issue Oct 26, 2016 · 1 comment
Closed

atleast_2d documentation #8214

mattharrigan opened this issue Oct 26, 2016 · 1 comment

Comments

@mattharrigan
Copy link
Contributor

The doc for atleast_2d says it returns "An array, or tuple of arrays", but actually returns an array or list of arrays. atleast_1d says it returns "An array, or sequence of arrays". I think a list is a sequence but I'm not 100% sure. Not sure if atleast_2d doc should say a list or sequence, but it shouldn't say a tuple. atleast_3d has a similar issue.
@mattharrigan mattharrigan mentioned this issue Oct 26, 2016
Closed
@shoyer
Copy link
Member

shoyer commented Oct 27, 2016

Both tuples and lists are sequences. In practice, I doubt anyone is relying on this but "list" is certainly more precise, so we should probably update the docs.

@gfyoung gfyoung mentioned this issue Oct 27, 2016
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@shoyer @mattharrigan