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

Add docstring to the core methods in the onc.py #9

Open
1 task
Tracked by #7
kan-fu opened this issue Nov 16, 2023 · 0 comments
Open
1 task
Tracked by #7

Add docstring to the core methods in the onc.py #9

kan-fu opened this issue Nov 16, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@kan-fu
Copy link
Collaborator

kan-fu commented Nov 16, 2023

For example this is for Discovery methods.

It is decided to use numpy style for the docstring. Useful link on the sphinx extension doc to auto generate doc from docstring.

Here is an example from pandas docstring guide.

  • Add a doctest file
@kan-fu kan-fu mentioned this issue Nov 16, 2023
3 tasks
@kan-fu kan-fu added the documentation Improvements or additions to documentation label Nov 16, 2023
@kan-fu kan-fu changed the title Add docstring to the core methods in the onc.onc.py based on the documentation Add docstring to the core methods in the onc.onc.py Nov 16, 2023
@kan-fu kan-fu changed the title Add docstring to the core methods in the onc.onc.py Add docstring to the core methods in the onc.py Nov 16, 2023
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
Development

No branches or pull requests

1 participant