# HG changeset patch # User Franz Glasner # Date 1778145678 -7200 # Node ID 5df4403f9e186f396f51f3c0485b10378957123b # Parent acd9073cbbe3548a77357a86d9d26162996547c8 Reformae the description of the lexer options diff -r acd9073cbbe3 -r 5df4403f9e18 docs/details-algpseudocode.rst --- 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}