comparison 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
comparison
equal deleted inserted replaced
141:acd9073cbbe3 142:5df4403f9e18
10 10
11 11
12 Lexer Options 12 Lexer Options
13 ============= 13 =============
14 14
15 `no_end` 15 .. describe:: no_end
16 16
17 Default: ``False`` 17 **Type:** `bool`
18 18
19 If ``True`` all the ``ENDxxx`` commands will be skipped and yield nothing. 19 **Default:** `False`
20 20
21 `gets` 21 If ``True`` all the ``\ENDxxx`` commands will be skipped and yield
22 22 nothing.
23 Default: ``←`` 23
24 24 .. describe:: gets
25 The operator symbol to be printed by the command ``\GETS``. 25
26 26 **Type:** `str` or `None`
27 Often used alternative: ``:=``. 27
28 28 **Default:** `None` (yields ``←``)
29 `remark` 29
30 30 The operator symbol to be printed by the command ``\GETS``.
31 Default: ``▷`` 31
32 32 An often used alternative is ``:=``.
33 The symbol to be printed as when starting comments with ``\REMARK`` or ``\REM`` 33
34 .. describe:: remark
35
36 **Type:** `str` or `None`
37
38 **Default:** `None` (yields ``▷``)
39
40 The symbol to be printed as when starting comments with
41 ``\REMARK`` or ``\REM``.
34 42
35 43
36 Comments 44 Comments
37 ======== 45 ========
38 46
94 \TEXT{\OUTPUT{Output 1\}} \OUTPUT{Output 1} 102 \TEXT{\OUTPUT{Output 1\}} \OUTPUT{Output 1}
95 \TEXT{\OUTPUTS{Output 2\}} \OUTPUTS{Output 2} 103 \TEXT{\OUTPUTS{Output 2\}} \OUTPUTS{Output 2}
96 104
97 \TEXT{\ENSURE{Whatever should be ensured!\}} \ENSURE{Whatever should be ensured!} 105 \TEXT{\ENSURE{Whatever should be ensured!\}} \ENSURE{Whatever should be ensured!}
98 106
99 \TEXT{\REQUIRE{Whatever should be required.\}} \REQUIRE{Whatever should be required.} 107 \TEXT{\REQUIRE{Whatever should be required.\}} \REQUIRE{Whatever should be required.}
100 108
101 \TEXT{\RETURNS{Return 2\}} \RETURNS{Return 2} 109 \TEXT{\RETURNS{Return 2\}} \RETURNS{Return 2}
102 110
103 \TEXT{\CALL{a function\}(p1, p2)} \CALL{a function}(p1, p2) 111 \TEXT{\CALL{a function\}(p1, p2)} \CALL{a function}(p1, p2)
104 112