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

Make a prettier documentation #6

Open
1 of 4 tasks
Cloudac7 opened this issue Sep 22, 2022 · 0 comments
Open
1 of 4 tasks

Make a prettier documentation #6

Cloudac7 opened this issue Sep 22, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Cloudac7
Copy link
Owner

Cloudac7 commented Sep 22, 2022

Now the documentation was implemented through mkdocstring. It is just a simple test for existing docstring. However, the documentation now is so poor that nobody could actually execute analysis with only these files. Therefore, a lot of work should be finished.

  • Fix most docstring for exsiting functions and classes
  • Make all docstring to the same style (We might just use the Google one)
  • Write a easy usage
  • Other things to be done
@Cloudac7 Cloudac7 added the documentation Improvements or additions to documentation label Sep 22, 2022
@Cloudac7 Cloudac7 pinned this issue Apr 11, 2024
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

1 participant