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/link.py

    r11302 r11367  
    1515 
    1616def compatible_channels(source_channel, sink_channel): 
    17     """Do the channels in link have compatible types, i.e. can they be 
     17    """ 
     18    Do the channels in link have compatible types, i.e. can they be 
    1819    connected based on their type. 
    1920 
     
    2829 
    2930def can_connect(source_node, sink_node): 
    30     """Return True if any output from `source_node` can be connected to 
     31    """ 
     32    Return True if any output from `source_node` can be connected to 
    3133    any input of `sink_node`. 
    3234 
     
    3638 
    3739def possible_links(source_node, sink_node): 
    38     """Return a list of (OutputSignal, InputSignal) tuples, that 
     40    """ 
     41    Return a list of (OutputSignal, InputSignal) tuples, that 
    3942    can connect the two nodes. 
    4043 
     
    4952 
    5053class SchemeLink(QObject): 
    51     """A instantiation of a link between two widget nodes in the scheme. 
     54    """ 
     55    A instantiation of a link between two :class:`.SchemeNode` instances 
     56    in a :class:`.Scheme`. 
    5257 
    5358    Parameters 
    5459    ---------- 
    55     source_node : `SchemeNode` 
     60    source_node : :class:`.SchemeNode` 
    5661        Source node. 
    57     source_channel : `OutputSignal` 
     62    source_channel : :class:`OutputSignal` 
    5863        The source widget's signal. 
    59     sink_node : `SchemeNode` 
     64    sink_node : :class:`.SchemeNode` 
    6065        The sink node. 
    61     sink_channel : `InputSignal` 
     66    sink_channel : :class:`InputSignal` 
    6267        The sink widget's input signal. 
    6368    properties : `dict` 
     
    105110 
    106111    def source_type(self): 
    107         """Return the type of the source channel. 
     112        """ 
     113        Return the type of the source channel. 
    108114        """ 
    109115        return name_lookup(self.source_channel.type) 
    110116 
    111117    def sink_type(self): 
    112         """Return the type of the sink channel. 
     118        """ 
     119        Return the type of the sink channel. 
    113120        """ 
    114121        return name_lookup(self.sink_channel.type) 
    115122 
    116123    def is_dynamic(self): 
    117         """Is this link dynamic. 
     124        """ 
     125        Is this link dynamic. 
    118126        """ 
    119127        return self.source_channel.dynamic and \ 
     
    121129            not (self.sink_type() is self.source_type()) 
    122130 
    123     def enabled(self): 
    124         """Is this link enabled. 
     131    def set_enabled(self, enabled): 
    125132        """ 
    126         return self.__enabled 
    127  
    128     def set_enabled(self, enabled): 
    129         """Enable/disable the link. 
     133        Enable/disable the link. 
    130134        """ 
    131135        if self.__enabled != enabled: 
     
    133137            self.enabled_changed.emit(enabled) 
    134138 
     139    def enabled(self): 
     140        """ 
     141        Is this link enabled. 
     142        """ 
     143        return self.__enabled 
     144 
    135145    enabled = Property(bool, fget=enabled, fset=set_enabled) 
    136146 
    137147    def set_dynamic_enabled(self, enabled): 
    138         """Enable/disable the dynamic link. Has no effect if 
    139         the link is not dynamic. 
     148        """ 
     149        Enable/disable the dynamic link. Has no effect if the link 
     150        is not dynamic. 
    140151 
    141152        """ 
     
    145156 
    146157    def dynamic_enabled(self): 
    147         """Is this dynamic link and `dynamic_enabled` set to True 
     158        """ 
     159        Is this a dynamic link and is `dynamic_enabled` set to `True` 
    148160        """ 
    149161        return self.is_dynamic() and self.__dynamic_enabled 
    150162 
    151163    dynamic_enabled = Property(bool, fget=dynamic_enabled, 
    152                                  fset=set_dynamic_enabled) 
     164                               fset=set_dynamic_enabled) 
    153165 
    154166    def set_tool_tip(self, tool_tip): 
    155         """Set the link tool tip. 
     167        """ 
     168        Set the link tool tip. 
    156169        """ 
    157170        if self.__tool_tip != tool_tip: 
     
    159172 
    160173    def tool_tip(self): 
    161         """Return the link's tool tip 
     174        """ 
     175        Link tool tip. 
    162176        """ 
    163177        return self.__tool_tip 
    164178 
    165179    tool_tip = Property(str, fget=tool_tip, 
    166                           fset=set_tool_tip) 
     180                        fset=set_tool_tip) 
    167181 
    168182    def __str__(self): 
Note: See TracChangeset for help on using the changeset viewer.