[doc/3.19] Clarify repoapi.get_repository usage
authorDenis Laxalde <denis.laxalde@logilab.fr>
Tue, 04 Feb 2014 11:23:58 +0100
changeset 9513 a7e0746f010c
parent 9512 88dc96fc9fc1
child 9519 32662203e334
[doc/3.19] Clarify repoapi.get_repository usage Followup for 9a62c52d167e.
doc/3.19.rst
--- a/doc/3.19.rst	Wed Jan 29 13:43:42 2014 +0100
+++ b/doc/3.19.rst	Tue Feb 04 11:23:58 2014 +0100
@@ -48,8 +48,9 @@
 
 There are three relevant functions for now:
 
-* ``repoapi.get_repository(config=config)`` takes a config object and returns a
-  Repository object.
+* ``repoapi.get_repository`` returns a Repository object either from an
+  URI when used as ``repoapi.get_repository(uri)`` or from a config
+  when used as ``repoapi.get_repository(config=config)``.
 
 * ``repoapi.connect(repo, login, **credentials)`` returns a ClientConnection
   associated with the user identified by the credentials. The