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

WHO dataset missing function call section in doc #181

Closed
agoscinski opened this issue Mar 31, 2023 · 1 comment
Closed

WHO dataset missing function call section in doc #181

agoscinski opened this issue Mar 31, 2023 · 1 comment
Labels
good first issue Good for newcomers

Comments

@agoscinski
Copy link
Collaborator

load_csd_1000r has the section https://scikit-matter.readthedocs.io/en/latest/datasets.html#skmatter.datasets.load_csd_1000r but not the who dataset https://scikit-matter.readthedocs.io/en/latest/datasets.html#who-dataset

Also I would try to change this to autofunction, not sure if this results in problems since the descriptions are in the code folder
https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-autofunction
@rosecers rosecers added the good first issue Good for newcomers label Apr 12, 2023
saswatnayak1998 pushed a commit that referenced this issue Apr 27, 2023
Resolved Issue WHO dataset missing function call section in doc #181
cad0f38
rosecers pushed a commit that referenced this issue Apr 28, 2023
@saswatnayak1998
Resolved Issue WHO dataset missing function call section in doc #181 (#…
2b4b94d 
…192)

* Resolved Issue WHO dataset missing function call section in doc #181

* changed grammer of Reference Code for who_dataset

* Changed grammer of Reference Code for who_dataset

* Corrected grammer of Reference Code for who_dataset

* Corrected grammer of Reference Code for who_dataset and corrected the linting error

---------

Co-authored-by: Saswat Kumar Nayak <habibi@Saswats-MacBook-Pro.local>
@rosecers
Copy link
Collaborator

Addressed in #192

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@agoscinski @rosecers