deeppavlov / deeppavlov/AutoIntent
Args name in signature and documentation mismatch
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 54
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
In some functions, our documentation not matching with signature
Ruff related issues https://github.com/astral-sh/ruff/pull/13286, https://github.com/astral-sh/ruff/pull/14496
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
Start by reviewing the functions whose documented argument names differ from their signatures, then read the referenced Ruff pull requests for context. Identify each mismatch and update the documentation so argument names consistently match the signatures; done means the affected documentation is aligned and checks pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100