Commit 3a6b8677 authored by Valentin Valls's avatar Valentin Valls
Browse files

Clean up documentation

parent f23f6c7b
......@@ -14,6 +14,21 @@ from bliss.common.utils import Null, autocomplete_property
class BeaconObject:
"""
Object which handle shared properties from the configuration.
Arguments:
config: A configuration node
name: if supplied, used instead of the `config` name.
path: Can be used to define an offset inside the `config` that
is supposed to be used as `config` for this object.
share_hardware: Means that several instances of bliss share the
same hardware and need to initialize it with the
configuration if no other peer has done it.
If share_hardware is False, initialization of
parameters will be done once per peer.
"""
class _config_getter(property):
pass
......@@ -115,17 +130,13 @@ class BeaconObject:
self.only_in_config = only_in_config
self.priority = priority
def __init__(self, config, name=None, path=None, share_hardware=True):
"""
* <config>: a configuration node
* <name>: if supplied, used instead of the config name.
* <path> (list): can be used to define an offset inside the config that
is supposed to be used as config for this object.
* <share_hardware>: means that several instances of bliss share the same hardware
and need to initialize it with the configuration if no other peer has done it.
If share_hardware is False, initialization of parameters will be done once per peer.
"""
def __init__(
self,
config: dict,
name: str = None,
path: list = None,
share_hardware: bool = True,
):
self._path = path
self._config_name = config.get("name")
self._share_hardware = share_hardware
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment