Skip to content

Commit 31bdb2b

Browse files
Add docs for longStringIn/Out
1 parent 21d510e commit 31bdb2b

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

docs/reference/api.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -308,13 +308,28 @@ All functions return a wrapped `ProcessDeviceSupportIn` or
308308
if given, or defaults to ``'FLOAT'``.
309309

310310

311-
The following function generates a specialised record.
311+
The following functions generates specialised records.
312312

313313
.. function:: Action(name, **fields)
314314

315315
Creates a record (using `boolOut`) which will always call the `on_update`
316-
method when processed. Used for action records. The `on_update` keyword
317-
should always be passed.
316+
method when processed. Used for action records. Either the `on_update` or
317+
`on_update_name` keyword should always be passed.
318+
319+
.. function::
320+
longStringIn(name, **fields)
321+
longStringOut(name, **fields)
322+
323+
Creates a Waveform record specialised to contain Python (Unicode) strings.
324+
Only accepts string values, and only returns string values. `initial_value`
325+
and ``length`` keywords accepted as per Waveform records.
326+
327+
If no ``length`` or `initial_value` is provided a default length of 256 is used.
328+
329+
.. note::
330+
If you wish to store byte strings, use a ``WaveformIn/Out`` record
331+
332+
318333

319334

320335
The following functions manage record names. The record device name must be

0 commit comments

Comments
 (0)