Skip to content

Commit

Permalink
numpydoc
Browse files Browse the repository at this point in the history
  • Loading branch information
rharkes committed Oct 7, 2024
1 parent c32ae46 commit cec6ae1
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,14 @@ The matching of negative to positive regions now needs to be done by the user af

## Development
* Clone the repository
* `pip install --no-build-isolation --editable .`
* `pip install --no-build-isolation --editable .[dev]`
* These tools are used in this project:
* ruff : Code formatting and linting
* bumpver : Automatic versioning
* pytest : Testing
* mypy : Type checking
* numpydoc : Checking docstring style
* isort : Sorting imports

### Notes on development
* The xml is relatively simple. There are Annotations and an annotation contains regions.
Expand Down

0 comments on commit cec6ae1

Please sign in to comment.