openstack/deb-python-pygit2
Code Issues Proposed changes

Merge remote-tracking branch 'carlos/doc-fixup'

Browse Source
This commit is contained in:
J. David Ibáñez
2014-07-10 12:37:32 +02:00
parent d8864bdf02 31fc235b59
commit 986128aa47
2 changed files with 8 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/references.rst
View File

@@ -109,10 +109,8 @@ Example::
>>> for entry in head.log():
... print(entry.message)
.. autoattribute:: pygit2.RefLogEntry.id_new
.. autoattribute:: pygit2.RefLogEntry.id_old
.. autoattribute:: pygit2.RefLogEntry.message
.. autoattribute:: pygit2.RefLogEntry.committer
.. autoclass:: pygit2.RefLogEntry
:members:
Notes
====================

38
docs/remotes.rst
View File

@@ -10,48 +10,22 @@ Remotes
The Remote type
====================
.. autoattribute:: pygit2.Remote.name
.. autoattribute:: pygit2.Remote.url
.. autoattribute:: pygit2.Remote.push_url
.. autoattribute:: pygit2.Remote.refspec_count
.. autoattribute:: pygit2.Remote.push_refspecs
.. autoattribute:: pygit2.Remote.fetch_refspecs
.. automethod:: pygit2.Remote.progress
.. automethod:: pygit2.Remote.transfer_progress
.. automethod:: pygit2.Remote.update_tips
.. automethod:: pygit2.Remote.get_refspec
.. automethod:: pygit2.Remote.fetch
.. automethod:: pygit2.Remote.push
.. automethod:: pygit2.Remote.save
.. automethod:: pygit2.Remote.add_push
.. automethod:: pygit2.Remote.add_fetch
.. autoclass:: pygit2.Remote
:members:
The TransferProgress type
===========================
This class contains the data which is available to us during a fetch.
.. autoattribute:: pygit2.TransferProgress.total_objects
.. autoattribute:: pygit2.TransferProgress.indexed_objects
.. autoattribute:: pygit2.TransferProgress.received_objects
.. autoattribute:: pygit2.TransferProgress.local_objects
.. autoattribute:: pygit2.TransferProgress.total_deltas
.. autoattribute:: pygit2.TransferProgress.indexed_deltas
.. autoattribute:: pygit2.TransferProgress.received_bytes
.. autoclass:: pygit2.remote.TransferProgress
:members:
The Refspec type
===================
.. autoattribute:: pygit2.Refspec.direction
.. autoattribute:: pygit2.Refspec.src
.. autoattribute:: pygit2.Refspec.dst
.. autoattribute:: pygit2.Refspec.force
.. autoattribute:: pygit2.Refspec.string
.. automethod:: pygit2.Refspec.src_matches
.. automethod:: pygit2.Refspec.dst_matches
.. automethod:: pygit2.Refspec.transform
.. automethod:: pygit2.Refspec.rtransform
.. autoclass:: pygit2.refspec.Refspec
:members:
Credentials
================