From 28ae47f42bcfee8ce5b33660798f6483a3e0f45d Mon Sep 17 00:00:00 2001 From: Michael Jones Date: Mon, 9 Jun 2014 22:28:04 +0100 Subject: [PATCH] Provide a doc example for discover_repository To clarify the behaviour and usage. --- docs/repository.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/repository.rst b/docs/repository.rst index c2bd0c2..1ce6191 100644 --- a/docs/repository.rst +++ b/docs/repository.rst @@ -33,6 +33,11 @@ Functions .. autofunction:: pygit2.discover_repository + Example:: + + >>> current_working_directory = os.getcwd() + >>> repository_path = discover_repository(current_working_directory) + >>> repo = Repository(repository_path) The Repository class