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

Inadequate docstring for function shape_to_size #279

Closed
bwohlberg opened this issue Apr 23, 2022 · 0 comments · Fixed by #289
Closed

Inadequate docstring for function shape_to_size #279

bwohlberg opened this issue Apr 23, 2022 · 0 comments · Fixed by #289
Assignees
@Michael-T-McCann
Labels
documentation Improvements or additions to documentation

Comments

@bwohlberg
Copy link
Collaborator

bwohlberg commented Apr 23, 2022 •
edited
Loading

The docstring of shape_to_size is missing a Returns section, and the description of what is returned is too vague.

scico/scico/numpy/util.py

Lines 190 to 195 in 4381be5

def shape_to_size(shape: Union[Shape, BlockShape]) -> Axes:
r"""Compute the size corresponding to a (possibly nested) shape.
Args:
shape: A shape tuple; possibly tuples.
"""

In addition, the return type annotation appears to be incorrect (should be int).
@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label Apr 23, 2022
@Michael-T-McCann Michael-T-McCann mentioned this issue May 5, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Michael-T-McCann Michael-T-McCann

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve docs lanl/scico
2 participants
@bwohlberg @Michael-T-McCann