Skip to content

Commit 7502ef1

Browse files
authored
ci: Fix pydocstyle version to prevent linting errors (#104)
This PR fixes the pipeline, currently broken after an update to pydocstyle. We did not previously pin a pydocstyle version in [`tox.ini`](https://github.com/sandialabs/firewheel/blob/986cb66cbfcd2d6adadbb1fa19b9eced838462aa/tox.ini#L38). A new command line option ([`--ignore-private-args`](https://jsh9.github.io/pydoclint/config_options.html#14---ignore-private-args-shortform--ipa-default-false)) was [added in pydocstyle 0.6.3](https://github.com/jsh9/pydoclint/blob/main/CHANGELOG.md#063---2025-03-30). The default value of that argument—which I believe we should be defaulting to—is `False` (e.g., _do not_ ignore private arguments); however, it seems like even though we are specifying private arguments in our docstrings, the check is still failing. This PR does not solve the problem or advocate any solution, it simply pins the previous behavior to fix the pipeline while we determine the best course of action. Closes #103.
1 parent 986cb66 commit 7502ef1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ basepython = python3
3535
skip_install = true
3636
deps =
3737
flake8~=7.0.0
38-
pydoclint[flake8]
38+
pydoclint[flake8]==0.6.2
3939
commands =
4040
flake8 {toxinidir}/src/firewheel/ {posargs}
4141

0 commit comments

Comments
 (0)