Skip to content

Commit

Permalink
shell: improve docstrings for the "session" type lexers
Browse files Browse the repository at this point in the history
fixes #1599
  • Loading branch information
birkenfeld committed Nov 11, 2020
1 parent 5ee1754 commit 40f6bc0
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions pygments/lexers/shell.py
Expand Up @@ -149,9 +149,10 @@ def get_tokens_unprocessed(self, text):
else:
yield index, token, value


class ShellSessionBaseLexer(Lexer):
"""
Base lexer for simplistic shell sessions.
Base lexer for shell sessions.
.. versionadded:: 2.1
"""
Expand Down Expand Up @@ -217,7 +218,8 @@ def get_tokens_unprocessed(self, text):

class BashSessionLexer(ShellSessionBaseLexer):
"""
Lexer for simplistic shell sessions.
Lexer for Bash shell sessions, i.e. command lines, including a
prompt, interspersed with output.
.. versionadded:: 1.1
"""
Expand Down Expand Up @@ -546,7 +548,8 @@ def _make_redirect_state(compound,

class MSDOSSessionLexer(ShellSessionBaseLexer):
"""
Lexer for simplistic MSDOS sessions.
Lexer for MS DOS shell sessions, i.e. command lines, including a
prompt, interspersed with output.
.. versionadded:: 2.1
"""
Expand Down Expand Up @@ -631,7 +634,8 @@ class TcshLexer(RegexLexer):

class TcshSessionLexer(ShellSessionBaseLexer):
"""
Lexer for Tcsh sessions.
Lexer for Tcsh sessions, i.e. command lines, including a
prompt, interspersed with output.
.. versionadded:: 2.1
"""
Expand Down Expand Up @@ -762,7 +766,8 @@ class PowerShellLexer(RegexLexer):

class PowerShellSessionLexer(ShellSessionBaseLexer):
"""
Lexer for simplistic Windows PowerShell sessions.
Lexer for PowerShell sessions, i.e. command lines, including a
prompt, interspersed with output.
.. versionadded:: 2.1
"""
Expand Down

0 comments on commit 40f6bc0

Please sign in to comment.