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/lexers/special.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/lexers/special.py')
-rw-r--r-- | pygments/lexers/special.py | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/pygments/lexers/special.py b/pygments/lexers/special.py index 5af9320a..8cd43246 100644 --- a/pygments/lexers/special.py +++ b/pygments/lexers/special.py @@ -20,6 +20,9 @@ __all__ = ['TextLexer', 'RawTokenLexer'] class TextLexer(Lexer): + """ + "Null" lexer, doesn't highlight anything. + """ name = 'Text only' aliases = ['text'] filenames = ['*.txt'] @@ -35,13 +38,13 @@ line_re = re.compile('.*?\n') class RawTokenLexer(Lexer): """ - Recreate a token stream formatted with the RawTokenFormatter. + Recreate a token stream formatted with the `RawTokenFormatter`. Additional options accepted: - ``compress`` - If set to "gz" or "bz2", decompress the token stream with - the given compression algorithm (default: ''). + `compress` + If set to ``"gz"`` or ``"bz2"``, decompress the token stream with + the given compression algorithm before lexing (default: ``''``). """ name = 'Raw token data' aliases = ['raw'] |