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

Add examples to docstrings in classes and functions #392

Open

RaczeQ opened this issue Oct 29, 2023 · 0 comments · May be fixed by #401

Labels

Collaborator

RaczeQ commented Oct 29, 2023 •

edited

Currently, the code usage isn't clear for new users. We should write examples in the docstring where needed just like pandas or scikit.

https://gist.github.com/redlotus/3bc387c2591e3e908c9b63b97b11d24e#file-docstrings-py-L142

RaczeQ changed the title ~~Add examples to docstrings in classes and functions.~~ Add examples to docstrings in classes and functions

RaczeQ added the documentation label

RaczeQ linked a pull request

that will close this issue

docs: add examples to docstrings #401

Draft

20 tasks

simonusher mentioned this issue

chore: set up tooling for code examples #409

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment