summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/techspecs
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/techspecs')
-rw-r--r--docs/source/techspecs/luareference.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/source/techspecs/luareference.rst b/docs/source/techspecs/luareference.rst
index 2da9a2cd02d..ec7727916db 100644
--- a/docs/source/techspecs/luareference.rst
+++ b/docs/source/techspecs/luareference.rst
@@ -1207,16 +1207,17 @@ Methods
^^^^^^^
image:load(filename)
- Loads the specified file as a media image. Returns ``"pass"`` or
- ``"fail"``.
+ Loads the specified file as a media image. Returns ``nil`` if no error
+ or a string describing an error if an error occurred.
image:load_software(name)
- Loads a media image described in a software list. Returns ``"pass"`` or
- ``"fail"``.
+ Loads a media image described in a software list. Returns ``nil`` if no
+ error or a string describing an error if an error occurred.
image:unload()
Unloads the mounted image.
image:create(filename)
Creates and mounts a media image file with the specified name. Returns
- ``"pass"`` or ``"fail"``.
+ ``nil`` if no error or a string describing an error if an error
+ occurred.
image:display()
Returns a “front panel display” string for the device, if supported. This
can be used to show status information, like the current head position or