openstack/deb-python-pygit2
Code Issues Proposed changes

Make it explicit that Refspec objects are not for construction

Browse Source
This commit is contained in:
Matthew Duggan
2015-01-09 00:19:17 -08:00
parent 5a06cd2688
commit 52ac41a362
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/remotes.rst
View File

@@ -32,6 +32,10 @@ This class contains the data which is available to us during a fetch.
The Refspec type The Refspec type
=================== ===================
Refspecs objects are not constructed directly, but returned by
:meth:`pygit2.Remote.get_refspec`. To create a new a refspec on a Remote, use
:meth:`pygit2.Remote.add_fetch` or :meth:`pygit2.Remote.add_push`.
.. autoclass:: pygit2.refspec.Refspec .. autoclass:: pygit2.refspec.Refspec
:members: :members: