comparison docs/details-algpseudocode.rst @ 165:88f872c50aae

Markup of Python objects in docs
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 08 May 2026 23:50:24 +0200
parents a4317957148b
children
comparison
equal deleted inserted replaced
164:a4317957148b 165:88f872c50aae
10 Lexer Options 10 Lexer Options
11 ============= 11 =============
12 12
13 .. describe:: prohibit_raiseonerror_filter 13 .. describe:: prohibit_raiseonerror_filter
14 14
15 **Type:** `bool` 15 **Type:** :py:class:`bool`
16 16
17 **Default:** `False` 17 **Default:** `False`
18 18
19 If ``True`` the `raiseonerror` filter is not allowed to be applied by 19 If ``True`` the `raiseonerror` filter is not allowed to be applied by
20 `Sphinx`_ when :py:meth:`Lexer.add_filter` is called. 20 `Sphinx`_ when :py:meth:`Lexer.add_filter` is called.
21 21
22 This setting does not apply to filters that are set by the standard 22 This setting does not apply to filters that are set by the standard
23 lexer option `filters`. 23 lexer option `filters`.
24 24
25 .. describe:: no_end 25 .. describe:: no_end
26 26
27 **Type:** `bool` 27 **Type:** :py:class:`bool`
28 28
29 **Default:** `False` 29 **Default:** `False`
30 30
31 If ``True`` all the ``\ENDxxx`` commands will be skipped and yield 31 If ``True`` all the ``\ENDxxx`` commands will be skipped and yield
32 nothing. 32 nothing.
33 33
34 .. describe:: gets 34 .. describe:: gets
35 35
36 **Type:** `str` or `None` 36 **Type:** :py:class:`str` or :py:obj:`None`
37 37
38 **Default:** `None` (yields ``←``) 38 **Default:** `None` (yields ``←``)
39 39
40 The operator symbol to be printed by the command ``\GETS``. 40 The operator symbol to be printed by the command ``\GETS``.
41 41
42 An often used alternative is ``:=``. 42 An often used alternative is ``:=``.
43 43
44 .. describe:: remark 44 .. describe:: remark
45 45
46 **Type:** `str` or `None` 46 **Type:** :py:class:`str` or :py:obj:`None`
47 47
48 **Default:** `None` (yields ``▷``) 48 **Default:** `None` (yields ``▷``)
49 49
50 The symbol to be printed as when starting comments with 50 The symbol to be printed as when starting comments with
51 ``\REMARK`` or ``\REM``. 51 ``\REMARK`` or ``\REM``.