Skip to content

Commit b5cc56f

Browse files
committed
try to standardize across doc pages
1 parent dd1eab3 commit b5cc56f

11 files changed

Lines changed: 902 additions & 1345 deletions

docs/_config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,13 @@
11
remote_theme: BCDA-APS/bcda-pages-style
2+
3+
callouts_level: quiet
4+
callouts:
5+
note:
6+
title: Note
7+
color: purple
8+
important:
9+
title: Important
10+
color: blue
11+
warning:
12+
title: Warning
13+
color: red

docs/device-support.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,9 @@ function read_enable(record)
137137
end
138138
```
139139

140-
Returning `nil` from an input callback leaves the record's value
141-
unchanged.
140+
{: .note }
141+
> Returning `nil` from an input callback leaves the record's value
142+
> unchanged.
142143
143144
### Output records
144145

@@ -178,8 +179,12 @@ end
178179
The PV Object
179180
-------------
180181

181-
The PV object passed to callbacks is the same type of object created by
182-
`epics.pv()`. It provides dot-syntax access to record fields:
182+
{: .note }
183+
> The PV object passed to callbacks is the same type created by
184+
> `epics.pv()`. See the [epics library documentation](libraries/epics-library)
185+
> for full details.
186+
187+
It provides dot-syntax access to record fields:
183188

184189
```lua
185190
function my_callback(record)
@@ -202,11 +207,10 @@ written by the callback.
202207
Error Handling
203208
--------------
204209

205-
If a callback function raises an error (via `error()` or a runtime
206-
fault), the record is placed into alarm. For input records, a
207-
`READ_ALARM` with `INVALID` severity is set. For output records, a
208-
`WRITE_ALARM` with `INVALID` severity is set. The error message is
209-
printed to the IOC console.
210+
{: .important }
211+
> If a callback raises an error, the record is placed into alarm
212+
> (`READ_ALARM` or `WRITE_ALARM` with `INVALID` severity). The error
213+
> message is printed to the IOC console.
210214
211215
This means library functions that raise errors on failure (such as
212216
`bytestream.client:read()` or `asyn.client:write()`) will automatically

0 commit comments

Comments
 (0)