[FEATURE]: Enhance docstrings as Google style - Githubissues

milvus-io / pymilvus

Python SDK for Milvus.

Apache License 2.0

1.03k stars 325 forks source link

[FEATURE]: Enhance docstrings as Google style #809

Open XuanYang-cn opened 3 years ago

XuanYang-cn commented 3 years ago

Is there an existing issue for this?

[X] I have searched the existing issues

Is your feature request related to a problem? Please describe.

https://google.github.io/styleguide/pyguide.html

https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html?highlight=example#google-vs-numpy

https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html

Describe the solution you'd like

No response

Describe alternatives you've considered

No response

Anything else?

No response

XuanYang-cn commented 2 years ago

/assign