Mercurial > hgrepos > Python > libs > pygments-lexer-pseudocode2
changeset 172:ad80fcbf7b47
Docs formatting
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Mon, 11 May 2026 14:49:52 +0200 |
| parents | 4b87a9ecffdd |
| children | 551c3421bccb |
| files | docs/filters.rst docs/lexer-algpseudocode.rst |
| diffstat | 2 files changed, 15 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/filters.rst Mon May 11 14:38:59 2026 +0200 +++ b/docs/filters.rst Mon May 11 14:49:52 2026 +0200 @@ -50,8 +50,14 @@ **token_from** **Type:** :py:class:`str` or :py:class:`pygments.token.Token` + The name of a token type (like ``Error``) or a token object + (like :py:class:`pygments.token.Token.Error`). + **token_to** **Type:** :py:class:`str` or :py:class:`pygments.token.Token` + The name of a token type (like ``Generic.Error``) or a token object + (like :py:class:`pygments.token.Token.Generic.Error`). + Replace all token types given in `token_from` by the token type given in `token_to`.
--- a/docs/lexer-algpseudocode.rst Mon May 11 14:38:59 2026 +0200 +++ b/docs/lexer-algpseudocode.rst Mon May 11 14:49:52 2026 +0200 @@ -91,10 +91,10 @@ **Type:** :py:class:`bool` - **Default:** `False` + **Default:** :py:obj:`None` - If ``True`` the `raiseonerror` filter is not allowed to be applied by - `Sphinx`_ when :py:meth:`Lexer.add_filter` is called. + If :py:obj:`True` the `raiseonerror` filter is not allowed to be + applied by `Sphinx`_ when :py:meth:`Lexer.add_filter` is called. This setting does not apply to filters that are set by the standard lexer option `filters`. @@ -103,16 +103,16 @@ **Type:** :py:class:`bool` - **Default:** `False` + **Default:** :py:obj:`False` - If ``True`` all the ``\ENDxxx`` commands will be skipped and yield + If :py:obj:`True` all the ``\ENDxxx`` commands will be skipped and yield no output. .. describe:: gets **Type:** :py:class:`str` or :py:obj:`None` - **Default:** `None` (yields ``←``) + **Default:** :py:obj:`None` (yields ``←``) The operator symbol to be printed by the command ``\GETS``. @@ -122,7 +122,7 @@ **Type:** :py:class:`str` or :py:obj:`None` - **Default:** `None` (yields ``▷``) + **Default:** :py:obj:`None` (yields ``▷``) The symbol to be printed as when starting comments with ``\REMARK`` or ``\REM``. @@ -398,7 +398,7 @@ \text{\END-LOOP} \END-LOOP .. note:: The output of END-commands can be suppressed by setting the - lexer option ``no_end`` to ``True``. + lexer option ``no_end`` to :py:obj:`True`. Names and Entities @@ -546,7 +546,7 @@ :lines: 2- With a customized `AlgPseudocodeLexer` and its `no_end` -option set to ``True``. +option set to :py:obj:`True`. .. literalinclude:: examples/example-1.pseudocode :language: NoEndAlgPseudocode