search

h2oai / cloud-discovery-py

H2O Cloud Discovery Client.
Apache License 2.0
4 stars 1 forks source link

docs: 📝 Change field comments to doc strings #48

Closed zoido closed 1 year ago

zoido commented 1 year ago

According to the PEP-257, this is how the fileds can be documented https://peps.python.org/pep-0257/#what-is-a-docstring

Preparation for: h2oai/cloud-discovery#170

zoido commented 1 year ago

@johnygomez. Thanks. I agree. Unfortunately peps.python.org/pep-0526 is not supported by the docs generator I have chosen. But I learnt that the #: comments that it supports are kind of semi standard established by sphinx.

Closing this PR and will use #: instead. Thanks.

zoido commented 1 year ago

superseded by https://github.com/h2oai/cloud-discovery-py/pull/51