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

improve documentation #116

Closed
leon1995 opened this issue Mar 28, 2023 · 0 comments
Closed

improve documentation #116

leon1995 opened this issue Mar 28, 2023 · 0 comments
Assignees
@deichmab-draeger
Labels
documentation Improvements or additions to documentation
Milestone
v2.0 release

Comments

@leon1995
Copy link
Member

leon1995 commented Mar 28, 2023 •
edited
Loading

  1. Add code documentation (at least for everything that is public)
  2. Add type annotations, because they improve the usability for users drastically
  3. Add a py.typed file. See PEP 561
@leon1995 leon1995 added the enhancement New feature or request label Mar 28, 2023
@leon1995 leon1995 added this to the Q2/2023 milestone Mar 28, 2023
@leon1995 leon1995 added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Mar 28, 2023
@leon1995 leon1995 changed the title add type annotations improve documentation Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@deichmab-draeger deichmab-draeger

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v2.0 release
Development

No branches or pull requests
3 participants
@leon1995 @deichmab-draeger @a-kleinf