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

Populate Docstrings #304

Open
dafajon opened this issue Dec 13, 2021 · 0 comments · May be fixed by #317
Open

Populate Docstrings #304

dafajon opened this issue Dec 13, 2021 · 0 comments · May be fixed by #317
Assignees
@dafajon @onatyap @ertugrul-dmr @Bkarabilli
Labels
cleanup-stay Issues that won't be removed as part of cleanup

Comments

@dafajon
Copy link
Contributor

dafajon commented Dec 13, 2021 •
edited
Loading

  • Usage and tutorials only help for highlight cases.
  • Library needs a proper documentation and before that elaborate docstrings for objects and methods.
  • numpy format is chosen.
  • Classes and methods that lack a proper docstring are identified by @ertugrul-dmr
  • Form a feature branch and populate docstrings.
@ertugrul-dmr ertugrul-dmr linked a pull request Feb 28, 2022 that will close this issue
Update Docstrings [Resolves #304] #317
Draft
@askarbozcan askarbozcan added the cleanup-stay Issues that won't be removed as part of cleanup label Aug 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dafajon dafajon

@onatyap onatyap

@ertugrul-dmr ertugrul-dmr

@Bkarabilli Bkarabilli

Labels
cleanup-stay Issues that won't be removed as part of cleanup
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update Docstrings [Resolves #304] GlobalMaksimum/sadedegel
5 participants
@dafajon @onatyap @askarbozcan @ertugrul-dmr @Bkarabilli