Changeset 1736:b3b664abcfdd in orange-bioinformatics for _bioinformatics/obiKEGG/entry/__init__.py


Ignore:
Timestamp:
04/05/13 19:43:36 (13 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Added sphinx rst documentation for obiKEGG.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • _bioinformatics/obiKEGG/entry/__init__.py

    r1734 r1736  
    1010from . import fields 
    1111from .parser import DBGETEntryParser 
     12 
     13 
     14# TODO: Remove the use of entry_decorate decorator 
     15# for constructing a DBEntry subclass, make fields 
     16# properties with __get__ method, and explicit assignment 
     17# and meaningful docstrings 
    1218 
    1319 
     
    6470    @property 
    6571    def entry_key(self): 
    66         """ Primary entry key used for querying. 
     72        """ 
     73        Primary entry key used for identifying the entry. 
    6774        """ 
    6875        return self.entry.split(" ", 1)[0] 
    6976 
    7077    def parse(self, text): 
     78        """ 
     79        Parse `text` string containing a formated DBGET entry. 
     80        """ 
    7181        parser = DBGETEntryParser() 
    7282        gen = parser.parse_string(text) 
     
    136146 
    137147    def format(self, section_indent=12): 
     148        """ 
     149        Return a DBGET formated string representation. 
     150        """ 
    138151        return "".join(f.format(section_indent) 
    139152                       for f in self.fields) 
Note: See TracChangeset for help on using the changeset viewer.