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.

Sign up for GitHub

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

Jump to bottom

Add docstring to python modules #2

Open
2 tasks
manuGil opened this issue Aug 12, 2024 · 0 comments
Open
2 tasks

Add docstring to python modules #2

manuGil opened this issue Aug 12, 2024 · 0 comments
Assignees
@jgrguric96
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@manuGil
Copy link
Member

manuGil commented Aug 12, 2024

  • Use Numpy style guidelines to add docstrings to the most important modules in the source code.
  • Add type-hints

P.S. Copilot does this very well and saves time
manuGil pushed a commit that referenced this issue Aug 14, 2024
@jgrguric96
Merge pull request #2 from jgrguric96/manuel/review
7d54f50 
Improvements to repo documentation and metadata
@jgrguric96 jgrguric96 self-assigned this Aug 14, 2024
@manuGil manuGil added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jgrguric96 jgrguric96

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@manuGil @jgrguric96