openstack/deb-python-pygit2
Code Issues Proposed changes

Improve diff & diff_to_buffer doc formatting

Browse Source 
We switch to a parameter list for both functions and add a return type.
We also remove the indentation from the second line of the explanation
which was causing Sphinx to return it as two lines instead of one
continuous one.

We also added return types.

I am not sure of the type of the GIT_DIFF* flags so I have not included
that.
This commit is contained in:
Michael Jones 2014-06-26 23:29:24 +01:00
parent 9811123922
commit b96b285cea
1 changed files with 12 additions and 12 deletions

24
src/blob.c

@ -41,17 +41,17 @@ PyDoc_STRVAR(Blob_diff__doc__,
"diff([blob, flag, old_as_path, new_as_path]) -> Patch\n"
"\n"
"Directly generate a :py:class:`pygit2.Patch` from the difference\n"
" between two blobs.\n"
"between two blobs.\n"
"\n"
"Arguments:\n"
":param Blob blob: the :py:class:`~pygit2.Blob` to diff.\n"
"\n"
"blob: the :py:class:`~pygit2.Blob` to diff.\n"
":param flag: a GIT_DIFF_* constant.\n"
"\n"
"flag: a GIT_DIFF_* constant.\n"
":param str old_as_path: treat old blob as if it had this filename.\n"
"\n"
"old_as_path: treat old blob as if it had this filename.\n"
":param str new_as_path: treat new blob as if it had this filename.\n"
"\n"
"new_as_path: treat new blob as if it had this filename.\n");
":rtype: Patch\n");
PyObject *
Blob_diff(Blob *self, PyObject *args, PyObject *kwds)
@ -82,17 +82,17 @@ PyDoc_STRVAR(Blob_diff_to_buffer__doc__,
"diff_to_buffer([buffer, flag, old_as_path, buffer_as_path]) -> Patch\n"
"\n"
"Directly generate a :py:class:`~pygit2.Patch` from the difference\n"
" between a blob and a buffer.\n"
"between a blob and a buffer.\n"
"\n"
"Arguments:\n"
":param Blob buffer: Raw data for new side of diff.\n"
"\n"
"buffer: Raw data for new side of diff.\n"
":param flag: a GIT_DIFF_* constant.\n"
"\n"
"flag: a GIT_DIFF_* constant.\n"
":param str old_as_path: treat old blob as if it had this filename.\n"
"\n"
"old_as_path: treat old blob as if it had this filename.\n"
":param str buffer_as_path: treat buffer as if it had this filename.\n"
"\n"
"buffer_as_path: treat buffer as if it had this filename.\n");
":rtype: Patch\n");
PyObject *
Blob_diff_to_buffer(Blob *self, PyObject *args, PyObject *kwds)