Skip to content

Commit 3238a58

Browse files
committed
More changes
1 parent ff1bf04 commit 3238a58

2 files changed

Lines changed: 30 additions & 5 deletions

File tree

template/.prettierignore

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Git
2+
.git/
3+
14
# Copier
25
.copier-answers*.yml
36

@@ -14,4 +17,16 @@ docs/docs/assets/
1417
.pytest_cache/
1518

1619
# MyPy
17-
.mypy_cache
20+
.mypy_cache/
21+
22+
# Ruff
23+
.ruff_cache/
24+
25+
# Node
26+
node_modules
27+
28+
# Misc
29+
.benchmarks
30+
.cache
31+
deps/
32+
tmp/

template/pyproject.toml.jinja

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ exclude = [
197197
]
198198
indent-width = 4
199199
line-length = 99 # See also `max-line-length` in [tool.ruff.lint.pycodestyle]
200-
preview = true # Enable new rules that are not yet stable, like DOC
200+
preview = true # Enable new rules that are not yet stable, like DOC
201201

202202
# Formatting options for Ruff
203203

@@ -214,6 +214,7 @@ quote-style = 'single' # But double quotes in docstrings (PEP 8, PEP 25
214214
select = [
215215
# Various rules
216216
#'C90', # https://docs.astral.sh/ruff/rules/#mccabe-c90
217+
#'D', # https://docs.astral.sh/ruff/rules/#pydocstyle-d
217218
'F', # https://docs.astral.sh/ruff/rules/#pyflakes-f
218219
#'FLY', # https://docs.astral.sh/ruff/rules/#flynt-fly
219220
#'FURB', # https://docs.astral.sh/ruff/rules/#refurb-furb
@@ -273,9 +274,14 @@ select = [
273274
# Ignore specific rules globally
274275
ignore = [
275276
'COM812', # https://docs.astral.sh/ruff/rules/missing-trailing-comma/
276-
# The following covered by [tool.pydoclint] section below
277-
'D', # https://docs.astral.sh/ruff/rules/#pydocstyle-d
277+
# The following is replaced by 'D'/[tool.ruff.lint.pydocstyle] and [tool.pydoclint]
278278
'DOC', # https://docs.astral.sh/ruff/rules/#pydoclint-doc
279+
# Disable, as [tool.format_docstring] split one-line docstrings into the canonical multi-line layout
280+
'D200', # https://docs.astral.sh/ruff/rules/unnecessary-multiline-docstring/
281+
# Temporary:
282+
'D100', # https://docs.astral.sh/ruff/rules/undocumented-public-module/#undocumented-publi-module-d100
283+
'D104', # https://docs.astral.sh/ruff/rules/undocumented-public-package/#undocumented-public-package-d104
284+
'DTZ005', # https://docs.astral.sh/ruff/rules/call-datetime-now-without-tzinfo/#call-datetime-now-without-tzinfo-dtz005
279285
]
280286

281287
# Ignore specific rules in certain files or directories
@@ -285,6 +291,7 @@ ignore = [
285291
]
286292
'tests/**' = [
287293
'ANN', # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
294+
'D', # https://docs.astral.sh/ruff/rules/#pydocstyle-d
288295
'DOC', # https://docs.astral.sh/ruff/rules/#pydoclint-doc
289296
'INP001', # https://docs.astral.sh/ruff/rules/implicit-namespace-package/
290297
'S101', # https://docs.astral.sh/ruff/rules/assert/
@@ -316,6 +323,9 @@ max-complexity = 10
316323
max-line-length = 99 # See also `line-length` in [tool.ruff]
317324
max-doc-length = 72
318325

326+
[tool.ruff.lint.pydocstyle]
327+
convention = 'numpy'
328+
319329
#############################
320330
# Configuration for pydoclint
321331
#############################
@@ -349,4 +359,4 @@ exclude = '\.' # Temporarily disable format-docstring until we are ready
349359
docstring_style = 'numpy'
350360
line_length = 72
351361
fix_rst_backticks = true
352-
verbose = 'default' # or 'diff' to show changes made to docstrings
362+
verbose = 'default'

0 commit comments

Comments
 (0)