Add style guidelines for `__repr__` methods of classes
Open
Beginner friendly
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 3
- Forks
- 2
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 3
Description
As discussed in https://github.com/pyfar/pyfar/issues/903, we intend to shorten and harmonize the __repr__ methods of classes implemented in all packages which are part of the pyfar ecosystem.
We should add guidelines on this to the contribution guidelines to avoid future fragmentation.
Contributor guide
No contributing guide indexed for this repository
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 reading the repository's contribution guidelines and the discussion in issue 903 about shortening and harmonizing repr methods. Done means the contribution guidelines document the agreed style for classes across the pyfar ecosystem and help prevent future fragmentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100