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

Improve TypeHints print in the doc #160

Closed
PProfizi opened this issue Sep 22, 2022 · 0 comments · Fixed by #164
Closed

Improve TypeHints print in the doc #160

PProfizi opened this issue Sep 22, 2022 · 0 comments · Fixed by #164
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@PProfizi
Copy link
Contributor

📝 Description of the feature

Following this pyansys guideline would improve the layout of our API documentation by removing typehinting from the signature and instead putting it at the level of each parameter.
This also removes the need to write the type required at the dosctring level apparently.
See ansys/pydpf-core#498.

💡 Steps for implementing the feature

https://dev.docs.pyansys.com/doc-style/docstrings.html#type-hints

🔗 Useful links and references

No response

@PProfizi PProfizi added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 22, 2022
This was referenced Sep 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant