Skip to content

Commit cf521b4

Browse files
DOC: Add descriptions to the Pixi tasks (#2508)
1 parent 479bd09 commit cf521b4

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

pixi.toml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ pytest-html = "*"
6363
pytest-cov = "*"
6464

6565
[feature.test.tasks]
66-
tests = "pytest"
67-
tests-notebooks = "pytest --nbval-lax docs/user_guide/examples"
66+
tests = { cmd = "pytest", description = "Run the test suite." }
67+
tests-notebooks = { cmd = "pytest --nbval-lax docs/user_guide/examples", description = "Run the user guide example notebooks as tests." }
6868

6969

7070
[feature.notebooks.dependencies]
@@ -87,29 +87,29 @@ sphinx-design = "*"
8787
sphinx-autoapi = "*"
8888

8989
[feature.docs.tasks]
90-
docs = "sphinx-build docs docs/_build"
91-
docs-watch = 'sphinx-autobuild docs docs/_build'
92-
docs-linkcheck = "sphinx-build -b linkcheck docs/ docs/_build/linkcheck"
90+
docs = { cmd = "sphinx-build docs docs/_build", description = "Build the documentation." }
91+
docs-watch = { cmd = "sphinx-autobuild docs docs/_build", description = "Build and auto-rebuild the documentation on changes." }
92+
docs-linkcheck = { cmd = "sphinx-build -b linkcheck docs/ docs/_build/linkcheck", description = "Verify all links in documentation don't 404." }
9393

9494
[feature.pre-commit.dependencies]
9595
pre_commit = "*"
9696

9797
[feature.pre-commit.tasks]
98-
lint = "pre-commit run --all-files"
98+
lint = { cmd = "pre-commit run --all-files", description = "Run all pre-commit linting hooks." }
9999

100100
[feature.numpydoc.dependencies]
101101
numpydoc = "*"
102102

103103
[feature.numpydoc.tasks]
104-
numpydoc-lint = "python tools/numpydoc-public-api.py"
104+
numpydoc-lint = { cmd = "python tools/numpydoc-public-api.py", description = "Lint public API docstrings with numpydoc." }
105105

106106
[feature.typing.dependencies]
107107
mypy = "*"
108108
lxml = "*" # in CI
109109
types-tqdm = "*"
110110

111111
[feature.typing.tasks]
112-
typing = "mypy src/parcels --install-types"
112+
typing = { cmd = "mypy src/parcels --install-types", description = "Run static type checking with mypy." }
113113

114114

115115
[environments]

0 commit comments

Comments
 (0)