Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Add examples to all user-facing docstrings #177

Closed
BalzaniEdoardo opened this issue Jun 19, 2024 · 2 comments
Closed

Add examples to all user-facing docstrings #177

BalzaniEdoardo opened this issue Jun 19, 2024 · 2 comments
Assignees
@BalzaniEdoardo

Comments

@BalzaniEdoardo
Copy link
Collaborator

BalzaniEdoardo commented Jun 19, 2024 •
edited
Loading

Make sure that all user facing function as a clear example.
@BalzaniEdoardo BalzaniEdoardo changed the title Revisit API Guide Content Add examples to all user-facing docstrings Sep 12, 2024
@BalzaniEdoardo BalzaniEdoardo self-assigned this Sep 12, 2024
@BalzaniEdoardo BalzaniEdoardo mentioned this issue Sep 12, 2024
Open
15 tasks
@BalzaniEdoardo
Copy link
Collaborator Author

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

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

@billbrod
Copy link
Member

Is this done? @pranmod01 did this on glm.py and basis.py, but we have other user-facing functions, right?

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@BalzaniEdoardo BalzaniEdoardo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@billbrod @BalzaniEdoardo