Mercurial > hgrepos > Python > libs > pygments-lexer-pseudocode2

comparison docs/lexer-algpseudocode.rst @ 172:ad80fcbf7b47

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs formatting
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 11 May 2026 14:49:52 +0200
parents 3c517c22df9c
children 95754197f5b3
comparison
equal deleted inserted replaced
171:4b87a9ecffdd 172:ad80fcbf7b47
89 89
90 .. describe:: prohibit_raiseonerror_filter 90 .. describe:: prohibit_raiseonerror_filter
91 91
92 **Type:** :py:class:`bool` 92 **Type:** :py:class:`bool`
93 93
94 **Default:** `False` 94 **Default:** :py:obj:`None`
95 95
96 If ``True`` the `raiseonerror` filter is not allowed to be applied by 96 If :py:obj:`True` the `raiseonerror` filter is not allowed to be
97 `Sphinx`_ when :py:meth:`Lexer.add_filter` is called. 97 applied by `Sphinx`_ when :py:meth:`Lexer.add_filter` is called.
98 98
99 This setting does not apply to filters that are set by the standard 99 This setting does not apply to filters that are set by the standard
100 lexer option `filters`. 100 lexer option `filters`.
101 101
102 .. describe:: no_end 102 .. describe:: no_end
103 103
104 **Type:** :py:class:`bool` 104 **Type:** :py:class:`bool`
105 105
106 **Default:** `False` 106 **Default:** :py:obj:`False`
107 107
108 If ``True`` all the ``\ENDxxx`` commands will be skipped and yield 108 If :py:obj:`True` all the ``\ENDxxx`` commands will be skipped and yield
109 no output. 109 no output.
110 110
111 .. describe:: gets 111 .. describe:: gets
112 112
113 **Type:** :py:class:`str` or :py:obj:`None` 113 **Type:** :py:class:`str` or :py:obj:`None`
114 114
115 **Default:** `None` (yields ``←``) 115 **Default:** :py:obj:`None` (yields ``←``)
116 116
117 The operator symbol to be printed by the command ``\GETS``. 117 The operator symbol to be printed by the command ``\GETS``.
118 118
119 An often used alternative is ``:=``. 119 An often used alternative is ``:=``.
120 120
121 .. describe:: remark 121 .. describe:: remark
122 122
123 **Type:** :py:class:`str` or :py:obj:`None` 123 **Type:** :py:class:`str` or :py:obj:`None`
124 124
125 **Default:** `None` (yields ``▷``) 125 **Default:** :py:obj:`None` (yields ``▷``)
126 126
127 The symbol to be printed as when starting comments with 127 The symbol to be printed as when starting comments with
128 ``\REMARK`` or ``\REM``. 128 ``\REMARK`` or ``\REM``.
129 129
130 To use a lexer with non-default options in `Sphinx`_ see section 130 To use a lexer with non-default options in `Sphinx`_ see section
396 \text{\END-FOR} \END-FOR 396 \text{\END-FOR} \END-FOR
397 \text{\END-FORALL} \END-FORALL 397 \text{\END-FORALL} \END-FORALL
398 \text{\END-LOOP} \END-LOOP 398 \text{\END-LOOP} \END-LOOP
399 399
400 .. note:: The output of END-commands can be suppressed by setting the 400 .. note:: The output of END-commands can be suppressed by setting the
401 lexer option ``no_end`` to ``True``. 401 lexer option ``no_end`` to :py:obj:`True`.
402 402
403 403
404 Names and Entities 404 Names and Entities
405 ================== 405 ==================
406 406
544 .. literalinclude:: examples/example-1.pseudocode 544 .. literalinclude:: examples/example-1.pseudocode
545 :language: algpseudocode 545 :language: algpseudocode
546 :lines: 2- 546 :lines: 2-
547 547
548 With a customized `AlgPseudocodeLexer` and its `no_end` 548 With a customized `AlgPseudocodeLexer` and its `no_end`
549 option set to ``True``. 549 option set to :py:obj:`True`.
550 550
551 .. literalinclude:: examples/example-1.pseudocode 551 .. literalinclude:: examples/example-1.pseudocode
552 :language: NoEndAlgPseudocode 552 :language: NoEndAlgPseudocode
553 :lines: 2- 553 :lines: 2-
554 554