Skip to content

Commit 918f547

Browse files
committed
Init pydocstyle and update pre-commit
1 parent defc4c4 commit 918f547

File tree

5 files changed

+11
-4
lines changed

5 files changed

+11
-4
lines changed

.github/CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
7474
[homepage]: https://www.contributor-covenant.org
7575

7676
For answers to common questions about this code of conduct, see
77-
https://www.contributor-covenant.org/faq
77+
https://www.contributor-covenant.org/faq

.pre-commit-config.yaml

+5-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# See https://pre-commit.com/hooks.html for more hooks
33
repos:
44
- repo: https://github.com/pre-commit/pre-commit-hooks
5-
rev: v4.2.0
5+
rev: v4.3.0
66
hooks:
77
- id: trailing-whitespace
88
- id: end-of-file-fixer
@@ -28,3 +28,7 @@ repos:
2828
rev: v2.34.0
2929
hooks:
3030
- id: pyupgrade
31+
- repo: https://github.com/pycqa/pydocstyle
32+
rev: 6.1.1 # pick a git hash / tag to point to
33+
hooks:
34+
- id: pydocstyle

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Guidelines](https://github.com/N3PDF/pineko/blob/main/.github/CONTRIBUTING.md).
3232

3333
## Documentation
3434
- The documentation is available here: <a href="https://pineko.readthedocs.io/en/latest/"><img alt="Docs" src="https://readthedocs.org/projects/pineko/badge/?version=latest"></a>
35-
- To build the documentation from source run
35+
- To build the documentation from source run
3636
```bash
3737
cd docs
3838
poetry run make html

data/grids/load.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
# theory example
77
# scp dom.mi.infn.it:/media/FK/fktables/data/grids/200-SLAC_NC_EM_D_F2.pineappl.lz4 ./200/SLAC_NC_EM_D_F2.pineappl.lz4
88
# scp dom.mi.infn.it:/media/FK/fktables/data/grids/200-SLAC_NC_EM_P_F2.pineappl.lz4 ./200/SLAC_NC_EM_P_F2.pineappl.lz4
9-
# scp dom.mi.infn.it:/media/FK/fktables_pineko/data/grids/208/HERA_NC_318GEV_EAVG_SIGMARED_BOTTOM.pineappl.lz4 ./208/HERA_NC_318GEV_EAVG_SIGMARED_BOTTOM.pineappl.lz4
9+
# scp dom.mi.infn.it:/media/FK/fktables_pineko/data/grids/208/HERA_CC_318GEV_EM_SIGMARED.pineappl.lz4 ./208/HERA_CC_318GEV_EM_SIGMARED.pineappl.lz4

pyproject.toml

+3
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,6 @@ max-line-length = 100
110110
[tool.pylint.design]
111111
# Maximum number of arguments for function / method
112112
max-args = 10
113+
114+
[tool.pydocstyle]
115+
convention = "numpy"

0 commit comments

Comments
 (0)