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.

Sign up for GitHub

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

Jump to bottom

Documentation improvements for Blob.diff and Blob.diff_to_buffer #378

Merged
merged 2 commits into from
Jun 27, 2014
Merged

Documentation improvements for Blob.diff and Blob.diff_to_buffer #378

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9811123
Fix docstrings for Blob.diff & diff_to_buffer
michaeljones Jun 26, 2014
b96b285
Improve diff & diff_to_buffer doc formatting
michaeljones Jun 26, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions src/blob.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,20 @@ extern PyObject *GitError;
extern PyTypeObject BlobType;

PyDoc_STRVAR(Blob_diff__doc__,
"diff([blob, flag, old_as_path, new_as_path] -> Patch\n"
"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)
Expand Down Expand Up @@ -79,20 +79,20 @@ Blob_diff(Blob *self, PyObject *args, PyObject *kwds)


PyDoc_STRVAR(Blob_diff_to_buffer__doc__,
"diff_to_buffer([buffer, flag, old_as_path, buffer_as_path] -> Patch\n"
"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)
Expand Down