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

Support assumptions and caveats in docstrings #9

Closed
foster999 opened this issue Mar 22, 2021 · 1 comment
Closed

Support assumptions and caveats in docstrings #9

foster999 opened this issue Mar 22, 2021 · 1 comment

Comments

@foster999
Copy link
Contributor

Support assumptions and caveats written within function/class documentation:
@foster999 foster999 mentioned this issue Jun 22, 2021
Merged
@foster999
Copy link
Contributor Author

Support for R roxygen @section added.

Python docstrings implementation would require users to configure a sphinx extension. Also, the format of an assumption wouldn't fit well into a docstring currently.

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

No branches or pull requests
1 participant
@foster999