Restore pydoclint, add class docstrings #4236
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
ssbarnea
requested changes
Jun 26, 2024
| @@ -71,10 +71,13 @@ repos: | |||
| - id: cspell | |||
| name: Spell check with cspell | |||
|
|
|||
| - repo: https://github.com/jsh9/pydoclint | |||
| rev: 0.5.1 | |||
| - repo: https://github.com/pycqa/flake8 | |||
There was a problem hiding this comment.
This is the big problematic:
- no pinning and automatic update of pydoclint itself
- flake8 maintenance "style".
- name of hook make is very hard to call it directly (a lot to type)
There was a problem hiding this comment.
I recognise the compromise here and am open to suggestions.
I do think it is important that what ever we do there is a corresponding extension for VsCode and feedback during development.
I wanted to bring attention to this as it is somewhat related, there is an ongoing conversation withing the ruff repo related to pydoclint. Hopefully the configuation here is short lived and ruff gets parity. astral-sh/ruff#458 (comment)
cidrblock
force-pushed
the
chore_restore_pydoclint
branch
from
3c7377d
to
1a6fea0
Compare
cidrblock
force-pushed
the
chore_restore_pydoclint
branch
from
3a3dde7
to
49a2163
Compare
cidrblock
added a commit
that referenced
this pull request
Jun 26, 2024
Since flake8 has been removed, VsCode no longer provided feedback during devleopment about new docstring errors. This PR add a new task called `pydoclint` that runs pydoclint in the background. Message from pydoclint are parsed with a regex and presented in the problems tab of VsCode by the task. VsCode does not have native support fdor running a task on save, so a new extension is added to support that. The flake8 extension is removed which was an oversight in #4235 Related #4236
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This reverts #4235
Depends on #4237 for the milestone fix
Flake8 is necessary as it is the only way to get realtime feedback during development using VsCode.
In this PR, the flake8 and pydoclint configurations are restored to what they were.
The latest version of pydoclint added class atribute checking in the class docstrings. Included are those docstrings such that precommit should pass the check.
This will also keep the pydoclint configuration consistent with some of the other team repos:
pytest-ansible
tox-ansible
ansible-creator
ansible-dev-environment
ansible-dev-tools
Note: an updater script was included if needed
Also: Having DOC as an external for ruff is not needed as there are no
noqas inline for DOC. It is unecessary configuration.