Python HAL doc: Document functions that throw a RuntimeError

Author: hdiethelm

docs/src/config/python-hal-interface.adoc

@@ -73,8 +73,8 @@ System information:
 
 hal.is_initialized()::
 Returns a boolean to indicate whether hal is initialized. The hal is initialized when there is
-at least one component. If this is not the case, many of the following functions will
-fail with the error: `Cannot call before creating component`
+at least one component. If this is not the case, many of the following functions will throw
+a `RuntimeError` exception: `Cannot call before creating component`
 
 .Example:
 [source,python]
@@ -94,14 +94,17 @@ type = hal.get_realtime_type()
 hal.get_realtime_type()::
 Returns the type of the running realtime system.
 Might return `hal.REALTIME_TYPE_UNINITIALIZED` if `rtapi_app` is not running.
-See xref:_hal_constants[realtime type constants].
+See xref:_hal_constants[realtime type constants]. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 hal.component_exists(_name_:string)::
-Returns a boolean to indicate whether or not the specified component exist at this time.
+Returns a boolean to indicate whether or not the specified component exist at this time. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 hal.component_is_ready(_name_:string)::
 Returns a boolean to indicate whether or not the specified component is in the ready state.
-Also returns False if the component does not exist.
+Also returns False if the component does not exist. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 .Example:
 [source,python]
@@ -123,7 +126,8 @@ See 'hal.set_msg_level()' and xref:_hal_constants[message constants] for list of
 hal.new_sig(_name_:string, _type_:enum)::
 Create a new signal (net) called _name_.
 The signal can carry information of _type_ content.
-Returns `True` on success.
+Returns `True` on success. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 .Example:
 [source,python]
@@ -135,7 +139,8 @@ if not hal.new_sig("signalname", hal.HAL_BIT):
 hal.connect(_pinname_:string, _signame_:string)::
 Connect the pin _pinname_ to signal _signame_.
 Both signal and pin must exist and both pin and signal must be of the same type.
-Returns `True` on success.
+Returns `True` on success. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 .Example:
 [source,python]
@@ -147,7 +152,8 @@ if not hal.connect("mycomp.pinname", "signalname"):
 hal.disconnect(_pinname_:string, _signame_:string)::
 Disconnect the pin _pinname_ from signal _signame_.
 Both signal and pin must exist.
-Returns `True` on success.
+Returns `True` on success. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 .Example:
 [source,python]
@@ -158,7 +164,8 @@ if not hal.disconnect("mycomp.pinname"):
 
 hal.pin_has_writer(_pinname_:string)::
 Returns `True` if pin with name _pinname_ is attached to a signal and there is at least one writer.
-Otherwise, `False` is returned.
+Otherwise, `False` is returned. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 .Example:
 [source,python]
@@ -172,8 +179,9 @@ else:
 hal.set_p(_name_:string, _value_:mixed)::
 Sets the pin or param called _name_ to _value_.
 The _name_ is the full name of the pin or param.
-The search order is pin names first, then parameter names.
+The search order is pin names first, then parameter names. +
 Throws a `RuntimeError` exception if the _name_ is not found. +
+Throws a `RuntimeError` exception if HAL is not initialized. +
 The type of _value_ depends on the type of the pin or param.
 Integer scalar types may use integers or a textual representation of an integer to set the value.
 Floating point type may use both integer, floating point and textual representation thereof to set the value.
@@ -195,14 +203,16 @@ The same rules for _value_ apply to 'set_s()' as to 'set_p()'. +
  +
 The 'set_s()' method has one special case when the signal is of type `hal.HAL_PORT` and it is fully connected.
 In that case, the call uses the _value_ to set the port's queue size and it must be a positive integer.
-See below xref:_hal_port_pipes[on configuring a port].
+See below xref:_hal_port_pipes[on configuring a port]. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 hal.get_value(_name_:string)::
 Returns the value of the pin, param or signal with _name_, searched in that order.
 Boolean types return `True` or `False`.
 Integer scalar types return an integer.
 Floating point types return a float.
-A `RuntimeError` exception is thrown if no pin, param or signal is found by that name.
+A `RuntimeError` exception is thrown if no pin, param or signal is found by that name. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 .Example:
 [source,python]
@@ -211,13 +221,16 @@ value = hal.get_value("iocontrol.0.emc-enable-in")
 ----
 
 hal.get_info_pins()::
-Returns a list of dictionary tuples as in `{"NAME":"pinname", "VALUE":<bool|int|float>, "TYPE":<int>, "DIRECTION":<int>}`.
+Returns a list of dictionary tuples as in `{"NAME":"pinname", "VALUE":<bool|int|float>, "TYPE":<int>, "DIRECTION":<int>}`. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 hal.get_info_params()::
-Returns a list of dictionary tuples as in `{"NAME":"paramname", "VALUE":<bool|int|float>, "TYPE":<int>, "DIRECTION":<int>}`.
+Returns a list of dictionary tuples as in `{"NAME":"paramname", "VALUE":<bool|int|float>, "TYPE":<int>, "DIRECTION":<int>}`. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 hal.get_info_signals()::
-Returns a list of dictionary tuples as in `{"NAME":"signame", "VALUE":<bool|int|float>, "TYPE":<int>, "DRIVER":"name"|None}`.
+Returns a list of dictionary tuples as in `{"NAME":"signame", "VALUE":<bool|int|float>, "TYPE":<int>, "DRIVER":"name"|None}`. +
+Throws a `RuntimeError` exception if HAL is not initialized.
 
 .Example:
 [source,python]