Avoid copying docstrings to derived classes but refer to base class
Open
Nobody has claimed this yet.
good first issue
- Dominant language
- Python
- Stars
- 346
- Forks
- 123
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 32
Description
See @sdrave's comment here.
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 with the discussion linked from pull request 1460, especially sdrave's comment, to determine the intended docstring behavior. Locate the relevant docstring handling entry point and any existing tests from that discussion; done means derived classes refer to the base-class docstrings instead of copying them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100