Skip to content

Commit c422b34

Browse files
Add additional info to ClearRecords documentation
1 parent 1e352ab commit c422b34

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/reference/api.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,9 @@ The following attributes allow more direct access to record creation.
428428

429429
.. function:: ClearRecords()
430430
This can be used to remove all created records. This means the same record
431-
names can be re-used for different record types.
431+
names can be re-used for different record types. This cannot be used once the
432+
record database has been loaded, and is only designed to be used to help with
433+
testing.
432434

433435
Finally, the following function is used to load record definitions before
434436
starting the IOC.

0 commit comments

Comments
 (0)