openstack/deb-python-pygit2
Code Issues Proposed changes

Provide a doc example for discover_repository

Browse Source 
To clarify the behaviour and usage.
This commit is contained in:
Michael Jones
2014-06-09 22:28:04 +01:00
parent bd322fa132
commit 28ae47f42b
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/repository.rst
View File

@@ -33,6 +33,11 @@ Functions
.. autofunction:: pygit2.discover_repository .. autofunction:: pygit2.discover_repository
Example::
>>> current_working_directory = os.getcwd()
>>> repository_path = discover_repository(current_working_directory)
>>> repo = Repository(repository_path)
The Repository class The Repository class