-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Documentation: format docstrings for dev docs #3353
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.
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
Open
C-Achard
wants to merge
29
commits into
arash/dev_docs
Choose a base branch
from
cy/dev-docs-formatting
base: arash/dev_docs
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+4,003
−5,011
Open
Changes from all commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
867de4c
Add mdformat hook and update docs scan/exclude
C-Achard 0937706
Use NumPy docstring style and widen line length
C-Achard 1a8d3cf
Format all docstrings
C-Achard c99aa9d
Format all docs
C-Achard 6125126
Add dev-docs to mdformat
C-Achard 4f32679
Disable mdformat pre-commit hook (broken)
C-Achard 84466b0
Revert "Format all docs"
C-Achard 794619b
use google-style docstrings + remove numpydoc
deruyter92 640deb2
apply ruff safe fixes all docstrings
deruyter92 2078850
docs: convert docstrings to Google style (batch A1)
deruyter92 d59328d
docs: convert docstrings to Google style (batch A2)
deruyter92 00425f4
docs: convert docstrings to Google style (batch A3)
deruyter92 0998f8e
docs: convert docstrings to Google style (batch A4)
deruyter92 944a561
docs: convert docstrings to Google style (batch A5)
deruyter92 1e33ab0
docs: convert docstrings to Google style (batch B1)
deruyter92 aede4c4
docs: convert docstrings to Google style (batch B2)
deruyter92 fd68cb0
docs: convert docstrings to Google style (batch B3)
deruyter92 741eb42
docs: convert docstrings to Google style (batch B4)
deruyter92 c046c73
docs: convert docstrings to Google style (batch B5)
deruyter92 1a50d1c
docs: convert docstrings to Google style (batch B6)
deruyter92 75046ae
docs: fix existing malformed Google style docstrings (batch C)
deruyter92 e589365
docs: fix existing outdated Google style docstrings (batch D)
deruyter92 2580c8b
doc: google docstyle fixes (audit)
deruyter92 c6d0a46
docs: fix examples in docstrings
deruyter92 dd04239
Docs: fix cli Args (was Options)
deruyter92 47a7485
docs: fix docstring exceptions (Raises) prose -> structured
deruyter92 30a2e36
docs: fix missing function descriptions in docstrings
deruyter92 4cbef89
docs: fix DLCLoader to_coco docstring
deruyter92 c949ffc
docs: manually fix incorrect args in docstrings (using griffe)
deruyter92 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's keep an eye on this issue.