Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs and import structure #506

Open
4 tasks
f-brinkmann opened this issue Oct 13, 2023 · 3 comments
Open
4 tasks

Improve docs and import structure #506

f-brinkmann opened this issue Oct 13, 2023 · 3 comments
Labels
documentation Everything related to docstrings and comments v0.7.0

Comments

@f-brinkmann
Copy link
Member

General

  • pyfar version: 0.5.4

Description

  • Unify documentation of classes, especially of magic functions like __init__
  • Document functions contained in the class files, e.g., add or deg2rad
  • Add information about handling complex time data to concepts/Arithmetic operations
  • stop importing class moduls, e.g., pyfar.classes.coordinates
@f-brinkmann f-brinkmann added documentation Everything related to docstrings and comments v0.7.0 labels Oct 13, 2023
@github-actions github-actions bot added this to To do in Code Backlog Oct 13, 2023
@artpelling
Copy link
Contributor

Maybe add the sorting of import blocks to the list?

@f-brinkmann
Copy link
Member Author

Do you mean the import ... statements in the Python files?

@artpelling
Copy link
Contributor

Do you mean the import ... statements in the Python files?

Yes. Maybe that is unrelated, though...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Everything related to docstrings and comments v0.7.0
Projects
Development

No branches or pull requests

2 participants