Skip to content

Inconsistent documentation of boxes #577

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
Open
vyasr opened this issue Jan 23, 2020 · 0 comments
Open

Inconsistent documentation of boxes #577

vyasr opened this issue Jan 23, 2020 · 0 comments
Assignees
@andkerr
Labels
documentation good first issue Good for newcomers

Comments

@vyasr
Copy link
Contributor

vyasr commented Jan 23, 2020

Docstrings for constructors and methods accepting boxes need to be systematically updated to reflect that they accept any valid input to freud.Box.from_box, not just box objects.
@bdice bdice added the good first issue Good for newcomers label Oct 13, 2020
@andkerr andkerr self-assigned this May 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andkerr andkerr

Labels
documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@vyasr @bdice @andkerr