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

[DOC] - ashpy.utils is not part of the API reference #59

Open
mr-ubik opened this issue Apr 1, 2020 · 6 comments
Open

[DOC] - ashpy.utils is not part of the API reference #59

mr-ubik opened this issue Apr 1, 2020 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@mr-ubik
Copy link
Contributor

mr-ubik commented Apr 1, 2020

Self explanatory ashpy.utilsis missing from the API reference.

@mr-ubik mr-ubik added the documentation Improvements or additions to documentation label Apr 1, 2020
@EmanueleGhelfi
Copy link
Contributor

Should we add it to the API reference? utils is not imported in the ashpy/__init__.py. They are two internals method.

@EmanueleGhelfi
Copy link
Contributor

EmanueleGhelfi commented Apr 6, 2020

@mr-ubik @galeone @iLeW ping

@galeone
Copy link
Member

galeone commented Apr 6, 2020

The log method (in utils) is extremely useful when doing custom logging, it should be documented and public; perhaps moved in a better location.

The validate_objects instead is too broad, is not ashpy related and it can be left private and in this broad ("utils") package.

@mr-ubik
Copy link
Contributor Author

mr-ubik commented Apr 7, 2020

I am in complete agreement with @galeone.

@EmanueleGhelfi
Copy link
Contributor

Name of the package containing the log method.

Options:

ashpy.tensorboard
ashpy.logging

@mr-ubik
Copy link
Contributor Author

mr-ubik commented Apr 7, 2020

This is a hard choice. 🤔 I would probably go with ashpy.tensorboard. since usually logging is used for referring CLI/console logging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants