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

Fix type hints to make docs happy #114

Open
2 tasks
timurcarstensen opened this issue Sep 8, 2024 · 0 comments
Open
2 tasks

Fix type hints to make docs happy #114

timurcarstensen opened this issue Sep 8, 2024 · 0 comments
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@timurcarstensen
Copy link
Collaborator

running mkdocs build --clean --strict will fail since some type hints are incorrect / missing. For example, some function docstrings will mention a return type but the function isn't type hinted.

  • fix type hints as mentioned by output of mkdocs build --clean --strict
  • add the --strict flag to the docs.yml github workflow
@timurcarstensen timurcarstensen added bug Something isn't working good first issue Good for newcomers labels Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant