Changeset 15 for trunk

Show
Ignore:
Timestamp:
08/07/05 23:08:56 (7 years ago)
Author:
mj
Message:

Further document that keys should all be obtainable from the domains collection utility.

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • trunk/src/chronolog/interfaces.py

    r14 r15  
    106106    If duration is set to None the entry is deemed empty and a storage is 
    107107    allowed to delete it. 
     108     
     109    .. note:: 
     110       All keys **must** be from obtainable from the domains collection  
     111       available as utility. 
    108112 
    109113    """ 
     
    148152        None can be discarded from the store completely. 
    149153 
     154        .. note:: 
     155           All keys on entries **must** be from obtainable from the domains  
     156           collection available as utility. 
     157 
    150158        """ 
    151159 
     
    166174        could return ((A, B, C), (A, B, D)), while (D) would onl return  
    167175        ((A, B, D),) 
    168  
     176  
     177        .. note:: 
     178           All keys **must** be from obtainable from the domains collection  
     179           available as utility. 
     180          
    169181        """ 
    170182 
     
    172184        """Get the first and last date for which there are log entries matching 
    173185 
    174         key 
     186        keys 
    175187            A set of ITimeLogKeys. 
    176188 
     
    181193        eligable, but a log entry against (A, B, C) is. 
    182194 
     195        .. note:: 
     196           All keys **must** be from obtainable from the domains collection  
     197           available as utility. 
     198 
    183199        """ 
    184200 
     
    197213        logged. Never terminates. 
    198214 
     215        .. note:: 
     216           All keys **must** be from obtainable from the domains collection  
     217           available as utility. 
     218 
    199219        """ 
    200220 
     
    214234        limited by the start_date and end_date. 
    215235 
     236        .. note:: 
     237           All keys **must** be from obtainable from the domains collection  
     238           available as utility. 
     239 
    216240    """ 
    217241 
     
    221245 
    222246    A timesheet is a view on a ITimeLogStore for a given time period and keys. 
     247 
     248    .. note:: 
     249       All keys **must** be from obtainable from the domains collection  
     250       available as utility. 
    223251 
    224252    """