# HG changeset patch # User Sylvain Thénault # Date 1284629270 -7200 # Node ID da77d3f95079079edc391c28faeef86446138130 # Parent e2d51d6ba6549ae67c04ab7aa0b51df25d9a46c8 [repo] docstring cleanup diff -r e2d51d6ba654 -r da77d3f95079 server/repository.py --- a/server/repository.py Thu Sep 16 11:27:26 2010 +0200 +++ b/server/repository.py Thu Sep 16 11:27:50 2010 +0200 @@ -410,6 +410,11 @@ # public (dbapi) interface ################################################ def stats(self): # XXX restrict to managers session? + """Return a dictionary containing some statistics about the repository + resources usage. + + This is a public method, not requiring a session id. + """ results = {} querier = self.querier source = self.system_source @@ -432,8 +437,9 @@ return results def get_schema(self): - """return the instance schema. This is a public method, not - requiring a session id + """Return the instance schema. + + This is a public method, not requiring a session id. """ try: # necessary to support pickling used by pyro @@ -443,8 +449,9 @@ self.schema.__hashmode__ = None def get_cubes(self): - """return the list of cubes used by this instance. This is a - public method, not requiring a session id. + """Return the list of cubes used by this instance. + + This is a public method, not requiring a session id. """ versions = self.get_versions(not (self.config.creating or self.config.repairing @@ -456,9 +463,10 @@ @cached def get_versions(self, checkversions=False): - """return the a dictionary containing cubes used by this instance - as key with their version as value, including cubicweb version. This is a - public method, not requiring a session id. + """Return the a dictionary containing cubes used by this instance + as key with their version as value, including cubicweb version. + + This is a public method, not requiring a session id. """ from logilab.common.changelog import Version vcconf = {} @@ -488,6 +496,11 @@ @cached def source_defs(self): + """Return the a dictionary containing source uris as value and a + dictionary describing each source as value. + + This is a public method, not requiring a session id. + """ sources = self.config.sources().copy() # remove manager information sources.pop('admin', None) @@ -499,7 +512,10 @@ return sources def properties(self): - """return a result set containing system wide properties""" + """Return a result set containing system wide properties. + + This is a public method, not requiring a session id. + """ session = self.internal_session() try: # don't use session.execute, we don't want rset.req set