Linter PR01 and PR02 for functions using arbitrary keyword arguments `**kwargs`
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
The numpydoc linter pretends that **kwargs is documented in params or other params as such. IMHO this makes little sense since the construct serves to have arbitrary parameter names. IMHO when a **... parameter is encountered, the linter should not pretend that it is described as a parameter and start accepting arbitrary parameter names in other parameters.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named in the issue. Locate the implementation and tests for linter checks PR01 and PR02, then inspect how **kwargs is treated in parameter documentation; done means arbitrary parameter names are accepted without treating **kwargs itself as documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100