Ignore:
Timestamp:
03/21/13 15:31:53 (13 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Fixed docstrings for scheme subpackage.

File:
1 edited

Legend:

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

    r11391 r11419  
    3030from .readwrite import scheme_to_ows_stream, parse_scheme 
    3131 
    32 from ..registry import WidgetDescription 
     32from ..registry import WidgetDescription, InputSignal, OutputSignal 
    3333 
    3434log = logging.getLogger(__name__) 
     
    201201        See also 
    202202        -------- 
    203         SchemeNode, Scheme.add_node 
     203        .SchemeNode, Scheme.add_node 
    204204 
    205205        """ 
     
    275275                 sink_node, sink_channel): 
    276276        """ 
    277         Create a new SchemeLink and add it to the scheme. 
    278  
    279         Same as:: 
    280  
    281             scheme.add_link(SchemeLink(source_node, source_channel, 
    282                                        sink_node, sink_channel)) 
     277        Create a new :class:`.SchemeLink` from arguments and add it to 
     278        the scheme. The new link is returned. 
    283279 
    284280        Parameters 
     
    286282        source_node : :class:`.SchemeNode` 
    287283            Source node of the new link. 
    288         source_channel : :class:`OutputSignal` 
     284        source_channel : :class:`.OutputSignal` 
    289285            Source channel of the new node. The instance must be from 
    290             `source_node.output_channels()` 
     286            ``source_node.output_channels()`` 
    291287        sink_node : :class:`.SchemeNode` 
    292288            Sink node of the new link. 
    293         sink_channel : :class:`InputSignal` 
     289        sink_channel : :class:`.InputSignal` 
    294290            Sink channel of the new node. The instance must be from 
    295             `sink_node.input_channels()` 
     291            ``sink_node.input_channels()`` 
    296292 
    297293        See also 
    298294        -------- 
    299         SchemeLink, Scheme.add_link 
     295        .SchemeLink, Scheme.add_link 
    300296 
    301297        """ 
     
    328324    def check_connect(self, link): 
    329325        """ 
    330         Check if the `link` can be added to the scheme. 
     326        Check if the `link` can be added to the scheme and raise an 
     327        appropriate exception. 
    331328 
    332329        Can raise: 
    333330            - :class:`TypeError` if `link` is not an instance of 
    334331              :class:`.SchemeLink` 
    335             - :class:`SchemeCycleError` if the `link` would introduce a cycle 
    336             - :class:`IncompatibleChannelTypeError` if the channel types are 
     332            - :class:`.SchemeCycleError` if the `link` would introduce a cycle 
     333            - :class:`.IncompatibleChannelTypeError` if the channel types are 
    337334              not compatible 
    338             - :class:`SinkChannelError` if a sink channel has a `Single` flag 
     335            - :class:`.SinkChannelError` if a sink channel has a `Single` flag 
    339336              specification and the channel is already connected. 
    340             - :class:`DuplicatedLinkError` if a `link` duplicates an already 
     337            - :class:`.DuplicatedLinkError` if a `link` duplicates an already 
    341338              present link. 
    342339 
     
    375372    def creates_cycle(self, link): 
    376373        """ 
    377         Would the `link` if added to the scheme introduce a cycle. 
     374        Return `True` if `link` would introduce a cycle in the scheme. 
     375 
     376        Parameters 
     377        ---------- 
     378        link : :class:`.SchemeLink` 
     379 
    378380        """ 
    379381        check_type(link, SchemeLink) 
     
    385387    def compatible_channels(self, link): 
    386388        """ 
    387         Do the channels in `link` have compatible types. 
     389        Return `True` if the channels in `link` have compatible types. 
     390 
     391        Parameters 
     392        ---------- 
     393        link : :class:`.SchemeLink` 
     394 
    388395        """ 
    389396        check_type(link, SchemeLink) 
     
    391398 
    392399    def can_connect(self, link): 
     400        """ 
     401        Return `True` if `link` can be added to the scheme. 
     402 
     403        See also 
     404        -------- 
     405        Scheme.check_connect 
     406 
     407        """ 
     408        check_type(link, SchemeLink) 
    393409        try: 
    394410            self.check_connect(link) 
    395411            return True 
    396         except (SchemeCycleError, IncompatibleChannelTypeError): 
     412        except (SchemeCycleError, IncompatibleChannelTypeError, 
     413                SinkChannelError, DuplicatedLinkError): 
    397414            return False 
    398         except Exception: 
    399             raise 
    400415 
    401416    def upstream_nodes(self, start_node): 
    402417        """ 
    403         Return a set of all nodes upstream from `start_node`. 
     418        Return a set of all nodes upstream from `start_node` (i.e. 
     419        all ancestor nodes). 
     420 
     421        Parameters 
     422        ---------- 
     423        start_node : :class:`.SchemeNode` 
     424 
    404425        """ 
    405426        visited = set() 
     
    419440        """ 
    420441        Return a set of all nodes downstream from `start_node`. 
     442 
     443        Parameters 
     444        ---------- 
     445        start_node : :class:`.SchemeNode` 
     446 
    421447        """ 
    422448        visited = set() 
     
    438464        of the child in the workflow). Both nodes must be in the scheme. 
    439465 
     466        Parameters 
     467        ---------- 
     468        node : :class:`.SchemeNode` 
     469        child : :class:`.SchemeNode` 
     470 
    440471        """ 
    441472        return child in self.downstream_nodes(node) 
     
    455486    def input_links(self, node): 
    456487        """ 
    457         Return all input links connected to the `node` instance. 
     488        Return a list of all input links (:class:`.SchemeLink`) connected 
     489        to the `node` instance. 
     490 
    458491        """ 
    459492        return self.find_links(sink_node=node) 
     
    461494    def output_links(self, node): 
    462495        """ 
    463         Return all output links connected to the `node` instance. 
     496        Return a list of all output links (:class:`.SchemeLink`) connected 
     497        to the `node` instance. 
     498 
    464499        """ 
    465500        return self.find_links(source_node=node) 
Note: See TracChangeset for help on using the changeset viewer.