From 18c480d1cb65ac05440e8fc9a7eebfe973d14c7d Mon Sep 17 00:00:00 2001 From: "P. Christeas" Date: Thu, 23 Jun 2011 12:03:57 +0300 Subject: [PATCH] netsvc: API doc title and docstring fixes bzr revid: xrg@linux.gr-20110623090357-vcr58sj3sbgd1r2i --- openerp/netsvc.py | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/openerp/netsvc.py b/openerp/netsvc.py index 42ccab414c7..eac8a13b8fe 100644 --- a/openerp/netsvc.py +++ b/openerp/netsvc.py @@ -63,6 +63,9 @@ def close_socket(sock): sock.close() +#.apidoc title: Common Services: netsvc +#.apidoc module-mods: member-order: bysource + class Service(object): """ Base class for *Local* services @@ -249,19 +252,22 @@ def init_alternative_logger(): logger.setLevel(logging.ERROR) class Agent(object): - """Singleton that keeps track of cancellable tasks to run at a given - timestamp. - The tasks are caracterised by: + """ Singleton that keeps track of cancellable tasks to run at a given + timestamp. + + The tasks are characterised by: + * a timestamp * the database on which the task run * the function to call * the arguments and keyword arguments to pass to the function Implementation details: - Tasks are stored as list, allowing the cancellation by setting - the timestamp to 0. - A heapq is used to store tasks, so we don't need to sort - tasks ourself. + + - Tasks are stored as list, allowing the cancellation by setting + the timestamp to 0. + - A heapq is used to store tasks, so we don't need to sort + tasks ourself. """ __tasks = [] __tasks_by_db = {}