Pyrato Docstring return type consistency
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Search the pyrato source for function docstrings whose return entries do not use the stated name : type form, such as edc : pyfar.TimeData. Review each inconsistent return entry and make the documentation consistent; done when the affected docstrings follow the agreed syntax.
Written by the indexing model from the issue text.
Description
Upon review it came to attention that multiple functions in pyrato are not consistent in their Docstring-Return type.
As @f-brinkmann proposed the correct syntax should be e.g.:
edc : pyfar.TimeData
- Dominant language
- Python
- Stars
- 25
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from pyfar/pyrato
-
[DOC] Docs build fails with sphinx-design 0.8: deprecated '^^^' card header separatorsPossibly taken @hoyer-a claimed this 2 days ago. Opendocumentation
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 67/100
-
FEAT: Implement coherence based intersection time method by Prawda et al.May be free again @mberz claimed this 36 days ago, and no pull request is open. Openenhancement
-
[ENH] Interaural cross-correlation: IACC_E, IACC_LPossibly taken @artur-pa claimed this 36 days ago. Openenhancement
-
[ENH] Stage support ST_early, ST_late (ISO 3382-1, Annex C)May be free again @artur-pa claimed this 36 days ago, and no pull request is open. Openenhancement
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kludex/python-multipart#375 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 3 days
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 11 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
FuRongJun-1999/dsh-memory#1000 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
gcivil-nyu-org/team5-mon-fall26#154 ·
Maintainers usually reply within 1 day