Skip to content
Snippets Groups Projects
Commit cdb76aba authored by Martin Lange's avatar Martin Lange
Browse files

tweak docs of connector-related methods

parent d6a48a27
No related branches found
No related tags found
1 merge request!154Auto-transfer infos
......@@ -205,7 +205,10 @@ class Component(IComponent, Loggable, ABC):
@property
def connector(self):
"""The component's ConnectHelper"""
"""The component's :class:`.tools.ConnectHelper`.
See also :meth:`.create_connector` and :meth:`.try_connect`.
"""
return self._connector
def create_connector(
......@@ -213,6 +216,8 @@ class Component(IComponent, Loggable, ABC):
):
"""Initialize the component's :class:`.tools.ConnectHelper`.
See also :meth:`.try_connect`, :attr:`.connector` and :class:`.ConnectHelper` for details.
Parameters
----------
pull_data : arraylike
......@@ -334,17 +339,17 @@ class Component(IComponent, Loggable, ABC):
Sets the component's :attr:`.status` according to success of exchange.
See :class:`.ConnectHelper` for more details.
See also :meth:`.create_connector`, :attr:`.connector` and :class:`.ConnectHelper` for details.
Parameters
----------
time : datetime.datatime
time for data pulls
exchange_infos : dict
exchange_infos : dict of [str, Info]
currently or newly available input data infos by input name
push_infos : dict
push_infos : dict of [str, Info]
currently or newly available output data infos by output name
push_data : dict
push_data : dict of [str, array-like]
currently or newly available output data by output name
"""
self.logger.debug("try connect")
......
......@@ -71,7 +71,7 @@ class ConnectHelper(Loggable):
Warning:
This class is not intended for direct use!
Use :meth:`.Components.create_connector` and :meth:`.Components.try_connect` instead.
Use :meth:`.Component.create_connector` and :meth:`.Component.try_connect` instead.
Parameters
----------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment