Skip to content

Commit dc4a63f

Browse files
Update documentation after code review
1 parent 421068e commit dc4a63f

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

docs/reference/api.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -165,18 +165,16 @@ Test Facilities`_ documentation for more details of each function.
165165

166166
This is used to specify an initial value for each record.
167167

168-
.. _status and severity:
168+
.. _status, severity:
169169

170-
`status and severity`
170+
`status, severity`
171171
~~~~~~~~~~~~~~~~~~~~~
172172

173173
Only available on IN records. These can be used with the alarm value enums
174-
from `softioc.alarm` to set the initial alarm state of a record.
174+
from `softioc.alarm` to set the initial alarm state and severity of a record.
175175

176-
.. note::
177-
178-
By default the builder module sets ``PINI`` to ``YES``, which means the
179-
record will process at initialization and the alarm status will be reset.
176+
These are not useful unless ``PINI`` is set to ``NO``, as otherwise the record
177+
will be processed on initialization and the alarm status will be reset.
180178

181179
.. _on_update:
182180

0 commit comments

Comments
 (0)