# HG changeset patch # User Julien Cristau # Date 1391096705 -3600 # Node ID 9a62c52d167e99d610d10a4a024f71f77aec3d55 # Parent 2b47e800cea6ead87d2ef52e91bcd99e8f9482e8 [doc/3.19] Make repoapi description match code diff -r 2b47e800cea6 -r 9a62c52d167e doc/3.19.rst --- a/doc/3.19.rst Mon Feb 03 18:19:26 2014 +0100 +++ b/doc/3.19.rst Thu Jan 30 16:45:05 2014 +0100 @@ -48,16 +48,17 @@ There are three relevant functions for now: -* ``repoapi.get_repository(config)`` takes a config object and return credential +* ``repoapi.get_repository(config=config)`` takes a config object and returns a + Repository object. -* ``repoapi.connect(repo, **credentials)`` returns a ClientConnection +* ``repoapi.connect(repo, login, **credentials)`` returns a ClientConnection associated with the user identified by the credentials. The ClientConnection is associated with its own Session that is closed when the ClientConnection is closed. A ClientConnection is a Connection-like object to be used client side. * ``repoapi.anonymous_cnx(repo)`` returns a ClientConnection associated - with the anonymous user if describe in the Config. + with the anonymous user if described in the config. repoapi.ClientConnection replace dbapi.Connection and company