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

refactor helpers/utils modules #502

Closed
sammlapp opened this issue May 28, 2022 · 1 comment
Closed

refactor helpers/utils modules #502

sammlapp opened this issue May 28, 2022 · 1 comment
Labels
resolved_in_develop The issue has been resolved in the develop branch but not in master
Milestone
0.11.0

Comments

@sammlapp
Copy link
Collaborator

The functionality of these modules is difficult to access or interpret because of lack of documentation and organization.
@sammlapp sammlapp added this to the 0.8.0 milestone Sep 20, 2022
@sammlapp sammlapp removed this from the 0.8.0 milestone Jan 13, 2023
@sammlapp sammlapp added the discuss Long term ideas to consider label Apr 12, 2024
@sammlapp sammlapp added this to the 0.11.0 milestone Apr 12, 2024
@sammlapp
Copy link
Collaborator Author

functions should only be placed in utils if they're not intended to be part of the public facing API. That said, even functions in utils modules should have dosctrings. I've checked that all functions have docstrings, and exposed public functions (just set_seed for now) in the top level API by importing in __init__.py

@sammlapp sammlapp added resolved_in_develop The issue has been resolved in the develop branch but not in master and removed discuss Long term ideas to consider labels Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
resolved_in_develop The issue has been resolved in the develop branch but not in master
Projects
None yet
Milestone
0.11.0
Development

No branches or pull requests
1 participant
@sammlapp