doc/mgr: document facilities methods using automethod directive
#18680
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
also update the docstring to confirm to http://www.sphinx-doc.org/en/stable/domains.html#info-field-lists. Signed-off-by: Kefu Chai <kchai@redhat.com>
Signed-off-by: Kefu Chai <kchai@redhat.com>
liuchang0812
reviewed
Nov 2, 2017
| """ | ||
| return self._ceph_get_server(None) | ||
|
|
||
| def get_metadata(self, svc_type, svc_id): | ||
| """ | ||
| Fetch the metadata for a particular service. | ||
| Fetch the daemon metadata for a particular service. |
There was a problem hiding this comment.
Hay, @tchaikov , It would be better to put docstring following """, for example:
def complex(real=0.0, imag=0.0):
"""Form a complex number.
Keyword arguments:
real -- the real part (default 0.0)
imag -- the imaginary part (default 0.0)
"""
if imag == 0.0 and real == 0.0:
return complex_zero
...
see python's docstring pep: https://www.python.org/dev/peps/pep-0257/
There was a problem hiding this comment.
i am trying to focus on what this PR addresses, instead of the compliance to pep-257 .
also,
"""
Form a complex number.
...
"""is more consistent with the python code in Ceph.
|
jenkins render docs |
|
Doc render available at http://docs.ceph.com/ceph-prs/18680/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.