Ignore:
Timestamp:
02/22/13 12:44:33 (14 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Added rst documentation for scheme package.

Fixing docstrings in the process.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Orange/OrangeCanvas/scheme/node.py

    r11302 r11367  
    1212 
    1313class SchemeNode(QObject): 
    14     """A widget node instantiation in the scheme. 
     14    """ 
     15    A node in a :class:`.Scheme`. 
    1516 
    1617    Parameters 
    1718    ---------- 
    18     description : `WidgetDescription` 
    19         Widget description. 
    20     title : `str` 
    21         Node title string (if None description.name is used). 
     19    description : :class:`WidgetDescription` 
     20        Node description instance. 
     21    title : str, optional 
     22        Node title string (if None `description.name` is used). 
    2223    position : tuple 
    23         (x, y) two-tuple for node position in a visual display. 
    24     properties : `dict` 
    25         Additional instance properties (settings, widget geometry, ...) 
    26     parent : `QObject` 
     24        (x, y) tuple of floats for node position in a visual display. 
     25    properties : dict 
     26        Additional extra instance properties (settings, widget geometry, ...) 
     27    parent : :class:`QObject` 
    2728        Parent object. 
    2829 
     
    4445 
    4546    def input_channels(self): 
    46         """Return the input channels for the node. 
    4747        """ 
    48         return self.description.inputs 
     48        Return a list of input channels (:class:`InputSignal`) for the node. 
     49        """ 
     50        return list(self.description.inputs) 
    4951 
    5052    def output_channels(self): 
    51         """Return the output channels for the node. 
    5253        """ 
    53         return self.description.outputs 
     54        Return a list of output channels (:class:`OutputSignal`) for the node. 
     55        """ 
     56        return list(self.description.outputs) 
    5457 
    5558    def input_channel(self, name): 
    56         """Return the input channel matching `name`. Raise an ValueError 
     59        """ 
     60        Return the input channel matching `name`. Raise a `ValueError` 
    5761        if not found. 
    5862 
     
    6569 
    6670    def output_channel(self, name): 
    67         """Return the output channel matching `name`. Raise an ValueError 
     71        """ 
     72        Return the output channel matching `name`. Raise an `ValueError` 
    6873        if not found. 
    6974 
     
    7580                         (name, self.description.name)) 
    7681 
    77     def __str__(self): 
    78         return u"SchemeNode(description_id=%s, title=%r, ...)" % \ 
    79                 (str(self.description.id), self.title) 
    80  
    81     def __repr__(self): 
    82         return str(self) 
    83  
     82    # The title of the node has changed 
    8483    title_changed = Signal(unicode) 
    85     """The title of the node has changed""" 
    8684 
    8785    def set_title(self, title): 
    88         """Set the node's title 
     86        """ 
     87        Set the node title. 
    8988        """ 
    9089        if self.__title != title: 
     
    9392 
    9493    def title(self): 
    95         """Return the nodes title. 
     94        """ 
     95        Return the node title. 
    9696        """ 
    9797        return self.__title 
     
    9999    title = Property(unicode, fset=set_title, fget=title) 
    100100 
     101    # Position of the node in the scheme has changed 
    101102    position_changed = Signal(tuple) 
    102     """Position of the node in the scheme has changed""" 
    103103 
    104104    def set_position(self, pos): 
    105         """Set the position of the node 
     105        """ 
     106        Set the position (``(x, y)`` tuple) of the node. 
    106107        """ 
    107108        if self.__position != pos: 
     
    110111 
    111112    def position(self): 
    112         """(x, y) tuple containing the position of the node in the scheme. 
     113        """ 
     114        ``(x, y)`` tuple containing the position of the node in the scheme. 
    113115        """ 
    114116        return self.__position 
     
    116118    position = Property(tuple, fset=set_position, fget=position) 
    117119 
     120    # Node's progress value has changed. 
    118121    progress_changed = Signal(float) 
    119     """Node's progress value has changed.""" 
    120122 
    121123    def set_progress(self, value): 
    122         """Set the progress value. 
     124        """ 
     125        Set the progress value. 
    123126        """ 
    124127        if self.__progress != value: 
     
    127130 
    128131    def progress(self): 
    129         """Return the current progress value. -1 if progress is not set. 
     132        """ 
     133        Return the current progress value. -1 if progress is not set. 
    130134        """ 
    131135        return self.__progress 
     
    133137    progress = Property(float, fset=set_progress, fget=progress) 
    134138 
     139    # Node's processing state has changed. 
    135140    processing_state_changed = Signal(int) 
    136     """Node's processing state has changed.""" 
    137141 
    138142    def set_processing_state(self, state): 
    139         """Set the node's processing state 
     143        """ 
     144        Set the node processing state. 
    140145        """ 
    141146        if self.__processing_state != state: 
     
    144149 
    145150    def processing_state(self): 
    146         """Return the node's processing state, 0 for not processing, 1 the 
     151        """ 
     152        Return the node processing state, 0 for not processing, 1 the 
    147153        node is busy. 
    148154 
     
    151157 
    152158    processing_state = Property(int, fset=set_processing_state, 
    153                                   fget=processing_state) 
     159                                fget=processing_state) 
    154160 
    155161    def set_tool_tip(self, tool_tip): 
     
    161167 
    162168    tool_tip = Property(str, fset=set_tool_tip, 
    163                           fget=tool_tip) 
     169                        fget=tool_tip) 
     170 
     171    def __str__(self): 
     172        return u"SchemeNode(description_id=%s, title=%r, ...)" % \ 
     173                (str(self.description.id), self.title) 
     174 
     175    def __repr__(self): 
     176        return str(self) 
Note: See TracChangeset for help on using the changeset viewer.