-
Notifications
You must be signed in to change notification settings - Fork 9
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
[python] Convert docstrings to Google style #151
Conversation
This also expands the docstrings for Experiment and Measurement.
Question: is the |
With the disclaimer that this is just my opinion: I expect it to be only human-readable. If we want to have a machine-parseable version of the lifecycle (which seems like a niche use case), I would have it in a function attribute (maybe set from . import lifecycle
@lifecycle.experimental
def some_func(...):
...
some_func.soma_lifecycle
# -> experimental |
Given this, I also prefer your proposed style (i.e., a new stanza), placed at the end of the docstring. We should update both packages if we go this route. |
I completely agree re human-readable, and that if we want programmatic access we could do a |
This also expands the docstrings for Experiment and Measurement.
In this change, I also changed the format of maturity levels to make them look like just another docs stanza. If we don’t like it, it can be reverted to the
[lifecycle: whatever]
style.Part of single-cell-data/TileDB-SOMA#974.