diff options
author | gbrandl <devnull@localhost> | 2007-01-12 22:53:02 +0100 |
---|---|---|
committer | gbrandl <devnull@localhost> | 2007-01-12 22:53:02 +0100 |
commit | 75dee451b1902e95b91c97f998af4c38e4ce670a (patch) | |
tree | eb7a1df61a6a1d8b0d75ae1dd957005a1b680005 /pygments/formatters/other.py | |
parent | efaccf6fd1322930aca142dd1a96d06d1bae84a3 (diff) | |
download | pygments-75dee451b1902e95b91c97f998af4c38e4ce670a.tar.gz |
[svn] Generate lexer, formatter and filter docs from docstrings.
There is the problem of ordering, though.
Diffstat (limited to 'pygments/formatters/other.py')
-rw-r--r-- | pygments/formatters/other.py | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/pygments/formatters/other.py b/pygments/formatters/other.py index f6101848..7ef39b4f 100644 --- a/pygments/formatters/other.py +++ b/pygments/formatters/other.py @@ -29,16 +29,18 @@ class NullFormatter(Formatter): class RawTokenFormatter(Formatter): - """ - Output a raw token representation for storing token streams. + r""" + Formats tokens as a raw representation for storing token streams. - The format is ``tokentype<TAB>repr(tokenstring)`` + The format is ``tokentype<TAB>repr(tokenstring)\n``. The output can later + be converted to a token stream with the `RawTokenLexer`, described in the + `lexer list <lexers.txt>`_. - Additional options accepted: + Only one option is accepted: - ``compress`` - If set to "gz" or "bz2", compress the token stream with - the given compression algorithm (default: ''). + `compress` + If set to ``'gz'`` or ``'bz2'``, compress the output with the given + compression algorithm after encoding (default: ``''``). """ unicodeoutput = False |