diff docs/details-algpseudocode.rst @ 142:5df4403f9e18

Reformae the description of the lexer options
author Franz Glasner <fzglas.hg@dom66.de>
date Thu, 07 May 2026 11:21:18 +0200
parents 4d55475d61a3
children b616f9645e37
line wrap: on
line diff
--- a/docs/details-algpseudocode.rst	Thu May 07 10:52:14 2026 +0200
+++ b/docs/details-algpseudocode.rst	Thu May 07 11:21:18 2026 +0200
@@ -12,25 +12,33 @@
 Lexer Options
 =============
 
-`no_end`
+  .. describe:: no_end
 
-  Default: ``False``
+     **Type:** `bool`
+
+     **Default:** `False`
 
-  If ``True`` all the ``ENDxxx`` commands will be skipped and yield nothing.
+     If ``True`` all the ``\ENDxxx`` commands will be skipped and yield
+     nothing.
 
-`gets`
+  .. describe:: gets
 
-  Default: ``←``
+     **Type:** `str` or `None`
 
-  The operator symbol to be printed by the command ``\GETS``.
+     **Default:** `None` (yields ``←``)
 
-  Often used alternative: ``:=``.
+     The operator symbol to be printed by the command ``\GETS``.
+
+     An often used alternative is ``:=``.
 
-`remark`
+  .. describe:: remark
+
+     **Type:** `str` or `None`
 
-  Default: ``▷``
+     **Default:** `None` (yields ``▷``)
 
-  The symbol to be printed as when starting comments with ``\REMARK`` or ``\REM``
+     The symbol to be printed as when starting comments with
+     ``\REMARK`` or ``\REM``.
 
 
 Comments
@@ -96,7 +104,7 @@
 
    \TEXT{\ENSURE{Whatever should be ensured!\}}       \ENSURE{Whatever should be ensured!}
 
-   \TEXT{\REQUIRE{Whatever should be required.\}}     \REQUIRE{Whatever should be required.}   
+   \TEXT{\REQUIRE{Whatever should be required.\}}     \REQUIRE{Whatever should be required.}
 
    \TEXT{\RETURNS{Return 2\}}                         \RETURNS{Return 2}