Skip to content
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

pybind: fix docstring for librbd Python binding #13977

Merged
merged 1 commit into from Mar 15, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 9 additions & 10 deletions src/pybind/rbd/rbd.pyx
Expand Up @@ -2333,7 +2333,7 @@ written." % (self.name, ret, length))
:type oncomplete: completion
:param fadvise_flags: fadvise flags for this read
:type fadvise_flags: int
:returns: str - the data read
:returns: :class:`Completion` - the completion object
:raises: :class:`InvalidArgument`, :class:`IOError`
"""

Expand Down Expand Up @@ -2375,20 +2375,19 @@ written." % (self.name, ret, length))
Raises :class:`InvalidArgument` if part of the write would fall outside
the image.

oncomplete will be called with the returned read value as
well as the completion:
oncomplete will be called with the completion:

oncomplete(completion, data_read)
oncomplete(completion)

:param offset: the offset to start reading at
:param data: the data to be written
:type data: bytes
:param offset: the offset to start writing at
:type offset: int
:param length: how many bytes to read
:type length: int
:param oncomplete: what to do when the read is complete
:param oncomplete: what to do when the write is complete
:type oncomplete: completion
:param fadvise_flags: fadvise flags for this read
:param fadvise_flags: fadvise flags for this write
:type fadvise_flags: int
:returns: str - the data read
:returns: :class:`Completion` - the completion object
:raises: :class:`InvalidArgument`, :class:`IOError`
"""

Expand Down