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 all user-facing docstrings #177

Open

BalzaniEdoardo opened this issue Jun 19, 2024 · 1 comment

Assignees

Collaborator

BalzaniEdoardo commented Jun 19, 2024 •

edited

Loading

Make sure that all user facing function as a clear example.

BalzaniEdoardo changed the title ~~Revisit API Guide Content~~ Add examples to all user-facing docstrings

BalzaniEdoardo self-assigned this

BalzaniEdoardo mentioned this issue

Revisit docs contents #221

Open

15 tasks

Collaborator Author

BalzaniEdoardo commented Oct 3, 2024

Use interactive shell syntax, so that doctest is run over all examples:

        Examples
        --------
        >>> # valid Examples section for docstrings
        >>> 3 + 1
        4

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