ansys / pydpf-post

Data Processing Framework - Post Processing Module
https://post.docs.pyansys.com
MIT License
43 stars 10 forks source link

Improve TypeHints print in the doc #160

Closed PProfizi closed 2 years ago

PProfizi commented 2 years ago

📝 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 pyansys/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