[DOC] Add import conventions
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 3
- Forks
- 2
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 3
Description
We agreed that harmonization of package imports is beneficial.
For readability the imports should be spelled out rather than abbreviated. (The pyfar base package can be an exception to this rule.)
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
Review the gallery's Python files to identify package imports that are abbreviated rather than spelled out, using the stated readability convention as the guide. Standardize the imports while allowing the pyfar base package exception; done means the relevant imports follow one consistent convention.
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