klen / klen/pylama

Pydocstyle release 6.2.0 breaks pylama

Open
#232 2 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1k
Forks
100
PR merge metrics
No merged PRs in 30d

Description

With the release of pydocstyle 6.2.0, they changed the method signature of `PyDocChecker().check_source` to have an additional parameter
https://github.com/PyCQA/pydocstyle/pull/546/files#diff-8036a1f043bf5856770399b0a1b5b13e7fc59cd1fc2e6bc2d8ca93f49a5d3406R134
```
def check_source(
self,
source,
filename,
ignore_decorators=None,
property_decorators=None,
ignore_inline_noqa=False,
)
```
So now it is passing in the `ignore_inline_noqa` value to the `property_decorators` param in
pylama_pycodestyle.py
```
for err in PyDocChecker().check_source(
ctx.source,
ctx.filename,
params.get("ignore_decorators"),
params.get("ignore_inline_noqa", False),
):
```

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in pylama_pycodestyle.py at the PyDocChecker().check_source call and compare its arguments with pydocstyle 6.2.0's signature. Update the integration so the intended ignore-inline-noqa value reaches the correct parameter, then run the existing test suite to verify compatibility with the released pydocstyle version.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.