Skip to content

Commit d6015b2

Browse files
committed
update cruft
1 parent 283f54f commit d6015b2

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

.cruft.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"template": "https://github.com/scverse/cookiecutter-scverse",
3-
"commit": "722725204d70783354e7a27a6d49220e6357176a",
3+
"commit": "009f1b5205d007026e76b3dd79f57ad946947ceb",
44
"checkout": null,
55
"context": {
66
"cookiecutter": {

docs/contributing.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ and [prettier][prettier-editors].
5151
## Writing tests
5252

5353
```{note}
54-
Remember to first install the package with `pip install '-e[dev,test]'`
54+
Remember to first install the package with `pip install -e '.[dev,test]'`
5555
```
5656

5757
This package uses the [pytest][] for automated testing. Please [write tests][scanpy-test-docs] for every function added
@@ -93,7 +93,7 @@ Before making a release, you need to update the version number in the `pyproject
9393
> Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
9494
9595
Once you are done, commit and push your changes and navigate to the "Releases" page of this project on GitHub.
96-
Specify `vX.X.X` as a tag name and create a release. For more information, see [managing Github releases][]. This will automatically create a git tag and trigger a Github workflow that creates a release on PyPI.
96+
Specify `vX.X.X` as a tag name and create a release. For more information, see [managing GitHub releases][]. This will automatically create a git tag and trigger a Github workflow that creates a release on PyPI.
9797

9898
## Writing documentation
9999

@@ -157,3 +157,4 @@ open _build/html/index.html
157157
[numpydoc]: https://numpydoc.readthedocs.io/en/latest/format.html
158158
[sphinx autodoc typehints]: https://github.com/tox-dev/sphinx-autodoc-typehints
159159
[pypi]: https://pypi.org/
160+
[managing GitHub releases]: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository

pyproject.toml

+9-4
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,14 @@ deps = ["pyproject.toml"] # Only look for declared dependencies here
7171
ignore_undeclared = ["flowsom"]
7272

7373
[tool.ruff]
74-
src = ["src"]
7574
line-length = 120
75+
src = ["src"]
76+
extend-include = ["*.ipynb"]
77+
78+
[tool.ruff.format]
79+
docstring-code-format = true
80+
81+
[tool.ruff.lint]
7682
select = [
7783
"F", # Errors detected by Pyflakes
7884
"E", # Error detected by Pycodestyle
@@ -112,12 +118,11 @@ ignore = [
112118
# We want docstrings to start immediately after the opening triple quote
113119
"D213",
114120
]
115-
extend-include = ["*.ipynb"]
116121

117-
[tool.ruff.pydocstyle]
122+
[tool.ruff.lint.pydocstyle]
118123
convention = "numpy"
119124

120-
[tool.ruff.per-file-ignores]
125+
[tool.ruff.lint.per-file-ignores]
121126
"docs/*" = ["I"]
122127
"tests/*" = ["D"]
123128
"*/__init__.py" = ["F401"]

0 commit comments

Comments
 (0)