Pyrato Docstring return type consistency

Open
#79 2 comments 0 reactions 0 assignees View on GitHub

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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pyfar/pyrato

All issues in pyfar/pyrato

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.