From dc4a63f829ecf51e30138a0f1be92707f777fca6 Mon Sep 17 00:00:00 2001 From: AlexWells Date: Fri, 14 Oct 2022 13:46:40 +0100 Subject: [PATCH] Update documentation after code review --- docs/reference/api.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/reference/api.rst b/docs/reference/api.rst index 1fe05be5..062200f3 100644 --- a/docs/reference/api.rst +++ b/docs/reference/api.rst @@ -165,18 +165,16 @@ Test Facilities`_ documentation for more details of each function. This is used to specify an initial value for each record. - .. _status and severity: + .. _status, severity: - `status and severity` + `status, severity` ~~~~~~~~~~~~~~~~~~~~~ Only available on IN records. These can be used with the alarm value enums - from `softioc.alarm` to set the initial alarm state of a record. + from `softioc.alarm` to set the initial alarm state and severity of a record. - .. note:: - - By default the builder module sets ``PINI`` to ``YES``, which means the - record will process at initialization and the alarm status will be reset. + These are not useful unless ``PINI`` is set to ``NO``, as otherwise the record + will be processed on initialization and the alarm status will be reset. .. _on_update: