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

[BUG] Improve sweep.yaml comment trigger #843

Merged
merged 2 commits into from
Oct 16, 2023
Merged

[BUG] Improve sweep.yaml comment trigger #843

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5f4faf
Update sweep.yaml
wwzeng1 Oct 16, 2023
2813e51
Update sweep.yaml
MatthewMiddlehurst Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sweep.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ sandbox:
- pre-commit run --files {file_path}

rules:
- "There should not be large chunks of code that are just commented out. Docstrings and explanations in code are okay though."
- "Comments should be instructive, such as inline and docstring comments. Remove any code that has been commented out."
- "Any clearly inefficient or redundant code can be optimized or refactored. Any improvements should not change the functionality of the code."
- "All public classes and functions should have a numpydoc style docstring. This should include a description of the class or function, the parameters, the class attributes or function return values, and a usage example for the class or function."
- "Update the relevant API page in 'docs/api_reference/' when new public functions and classes are added and not included in the API documentation. For example, if a new function is added to 'aeon/distances/', a `sphinx.ext.autosummary link` should also be added to 'docs/api_reference/distances.rst'. New sections in the page should not be created for individual functions and classes, add it to the most relevant existing one. Only add functions and classes which are not already in the relevant API page and avoid duplicate entries."
Expand Down