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

Improve in-code documentation #175

Open
xSAVIKx opened this issue Jul 11, 2022 · 2 comments
Open

Improve in-code documentation #175

xSAVIKx opened this issue Jul 11, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@xSAVIKx
Copy link
Member

xSAVIKx commented Jul 11, 2022

Almost all code now lacks proper pydocs across almost all the codebase. We should consider the following PRs are gonna improve the situation.

It should be prohibited to merge PRs that do not have docs. We should eventually cover all the missing places with appropriate documentation and examples.
@xSAVIKx xSAVIKx added the enhancement New feature or request label Jul 24, 2022
@owensun2004
Copy link

Hi! I would love to work on this issue. Could I please be assigned to work on it?

@xSAVIKx
Copy link
Member Author

xSAVIKx commented Nov 7, 2023

Hey @owensun2004, thank you for your interest. You're very welcome to create a PR whenever you're up to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@xSAVIKx @owensun2004