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

Make sure python parameters match docs #1268

Closed
nikolausWest opened this issue Feb 14, 2023 · 1 comment
Closed

Make sure python parameters match docs #1268

nikolausWest opened this issue Feb 14, 2023 · 1 comment
Labels
🧑‍💻 dev experience developer experience (excluding CI) 📖 documentation Improvements or additions to documentation enhancement New feature or request

Comments

@nikolausWest
Copy link
Member

nikolausWest commented Feb 14, 2023

Go through the all the api's in the Python SDK and make sure all the following match:

  • The parameter type hints
  • The parameter docstrings
  • The actual handling of that parameter in the code

Whenever it's too hard to get the type hints to match reality, default to setting a broader type hint and describing the actual type parameters in the docstring

@nikolausWest nikolausWest added 📖 documentation Improvements or additions to documentation enhancement New feature or request 🧑‍💻 dev experience developer experience (excluding CI) labels Feb 14, 2023
@jondo2010 jondo2010 self-assigned this Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧑‍💻 dev experience developer experience (excluding CI) 📖 documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants