Skip to content

Commit

Permalink
sweep revert
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewMiddlehurst committed Nov 16, 2023
1 parent daab2b7 commit cfab07f
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions sweep.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
gha_enabled: True
branch: "main"
blocked_dirs: [".github/", "_tsml_group_experiments/", "results/", "tsml_eval/publications/"]
blocked_dirs: [".github/", "_tsml_group_experiments", "results/", "tsml_eval/publications/"]
draft: False
description: "time-series-machine-learning/tsml-eval is a Python project for running experiments on time series machine learning algorithms and evaluating the results. Write code that adheres to PEP8 and is formatted to the Black code style. The projects documentation is built using Sphinx and MyST, and unit testing is done using pytest."

Expand All @@ -21,6 +21,5 @@ sandbox:
- pre-commit run --files {file_path}

rules:
- "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 except test 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."
- "There should not be large chunks of code that are just commented out. Docstrings and explanations in code are okay though."
- "Update the relevant API page in 'docs/api.md' when new public functions and classes are added and not included in the API documentation. Only add functions and classes which are not already in the relevant API documentation and avoid duplicate entries. Files in 'tsml_eval/publications/' do not need to be added to the API documentation."

0 comments on commit cfab07f

Please sign in to comment.