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

Convert docstrings to Sphinx style #78

Closed
Mark2000 opened this issue Oct 19, 2023 · 2 comments · Fixed by #109
Closed

Convert docstrings to Sphinx style #78

Mark2000 opened this issue Oct 19, 2023 · 2 comments · Fixed by #109
Labels
documentation Improvements or additions to documentation infrastructure Testing, documentation, and CI system refactor Refactor only. No new features.

Comments

@Mark2000
Copy link
Contributor

Mark2000 commented Oct 19, 2023 •
edited
Loading

Part of #17 (unless unnecessary, see linked issue for more details)
@Mark2000 Mark2000 added enhancement New feature or request documentation Improvements or additions to documentation refactor Refactor only. No new features. and removed enhancement New feature or request labels Oct 19, 2023
@Mark2000 Mark2000 added the infrastructure Testing, documentation, and CI system label Oct 31, 2023
@Mark2000 Mark2000 mentioned this issue Nov 1, 2023
Closed
7 tasks
@johnowagon
Copy link
Contributor

Since this is a large PR im going to make this separate from #17 and create a new branch for it. Instead of Converting them all to sphinx style I think it makes more sense to use the current style (some numpy, some google, some sphinx) and utilize sphinx.ext.napoleon to handle them all.

johnowagon added a commit that referenced this issue Dec 7, 2023
@johnowagon
Issue #78: Formatted docstrings to better utilize sphinx-apidoc
3cf03e0
@Mark2000
Copy link
Contributor Author

Mark2000 commented Dec 7, 2023

Nice, looks like that can also handle the type annotations: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#type-annotations

johnowagon added a commit that referenced this issue Dec 11, 2023
@johnowagon
Issue #78: Formatted docstrings to better utilize sphinx-apidoc
1692bc2
johnowagon added a commit that referenced this issue Dec 11, 2023
@johnowagon
Issue #78: Added ruff configuration to check docstring style
bad876d
johnowagon added a commit that referenced this issue Dec 11, 2023
@johnowagon
Issue #78: Moved configuration of ruff to the right file
160890c
johnowagon added a commit that referenced this issue Dec 11, 2023
@johnowagon
Issue #78: Added ruff configuration to check docstring style
0d213a3
johnowagon added a commit that referenced this issue Dec 11, 2023
@johnowagon
Issue #78: Formatted docstrings to better utilize sphinx-apidoc
3a5e371
johnowagon added a commit that referenced this issue Dec 11, 2023
@johnowagon
Issue #78: Removed strict linting
e332642
Mark2000 added a commit that referenced this issue Dec 28, 2023
@Mark2000
Issue #78: Docstring formatting rules
0668d07
@Mark2000 Mark2000 mentioned this issue Dec 28, 2023
Merged
15 tasks
Mark2000 added a commit that referenced this issue Dec 28, 2023
@Mark2000
Issue #78: Docstring formatting rules
e01c6c0
Mark2000 added a commit that referenced this issue Dec 28, 2023
@Mark2000
Issue #78: Docstring formatting rules
f8d5f7b
Mark2000 added a commit that referenced this issue Dec 28, 2023
@Mark2000
Issue #78: Docstring formatting rules
9a5b005
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation infrastructure Testing, documentation, and CI system refactor Refactor only. No new features.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Feature/78 ruff docstring formatting AVSLab/bsk_rl
2 participants
@Mark2000 @johnowagon