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

[always] Type Hints and Documentation #4

Open
san-ghun opened this issue Nov 20, 2024 · 0 comments
Open

[always] Type Hints and Documentation #4

san-ghun opened this issue Nov 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation wontfix This will not be worked on

Comments

@san-ghun
Copy link
Owner

While there are some type hints, they could be more comprehensive.

Consider:

  • Adding return type hints to all functions
  • Using more specific types instead of Any
  • Adding comprehensive docstrings with examples
@san-ghun san-ghun added documentation Improvements or additions to documentation wontfix This will not be worked on labels Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation wontfix This will not be worked on
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@san-ghun