Skip to content

Commit 540d3c1

Browse files
committed
Update documentation on the 'handle-unsupported-macros' property
1 parent 72b724c commit 540d3c1

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

sphinx/source/asm.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1373,7 +1373,8 @@ Recognised property names and their default values are:
13731373
(default: ``10``)
13741374
* ``crlf`` - ``1`` to use CR+LF to terminate lines, or ``0`` to use the system
13751375
default (default: ``0``)
1376-
* ``handle-unsupported-macros`` - how to handle an unsupported macro: ``1`` to
1376+
* ``handle-unsupported-macros`` - how to handle an unsupported macro (i.e.
1377+
:ref:`AUDIO` or any of the :ref:`image macros <imageMacros>`): ``1`` to
13771378
expand it to an empty string, or ``0`` to exit with an error (default: ``0``)
13781379
* ``indent`` - the number of spaces by which to indent instructions (default:
13791380
``2``)

sphinx/source/skool-macros.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -898,7 +898,8 @@ General macros
898898

899899
#AUDIO
900900
------
901-
In HTML mode, the ``#AUDIO`` macro expands to an HTML5 ``<audio>`` element. ::
901+
In HTML mode, the ``#AUDIO`` macro expands to an HTML5 ``<audio>`` element. It
902+
is not supported in ASM mode. ::
902903

903904
#AUDIOsim[,start,stop,execint,cmio,offset,maf,ay,bpr](fname)[(delays)]
904905

@@ -1988,10 +1989,10 @@ The ``#VERSION`` macro expands to the version of SkoolKit. ::
19881989

19891990
Image macros
19901991
^^^^^^^^^^^^
1991-
The :ref:`COPY`, :ref:`FONT`, :ref:`OVER`, :ref:`PLOT`, :ref:`SCR`, :ref:`UDG`,
1992-
:ref:`UDGARRAY` and :ref:`UDGS` macros (described in the following sections)
1993-
may be used to create images based on graphic data in the memory snapshot. They
1994-
are not supported in ASM mode.
1992+
The :ref:`COPY`, :ref:`FRAMES`, :ref:`FONT`, :ref:`OVER`, :ref:`PLOT`,
1993+
:ref:`SCR`, :ref:`UDG`, :ref:`UDGARRAY` and :ref:`UDGS` macros (described in
1994+
the following sections) may be used to create images based on graphic data in
1995+
the memory snapshot. They are not supported in ASM mode.
19951996

19961997
Some of these macros have several numeric parameters, most of which are
19971998
optional. This can give rise to a long sequence of commas in a macro parameter

0 commit comments

Comments
 (0)