diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2017-09-22 14:08:03 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-22 14:08:03 -0400 |
| commit | 7530674e171a57adc599740fb68eeac0313ee2ae (patch) | |
| tree | ab8051de5c5c448357ae5f7567711367e5034d8f /docs | |
| parent | 6d711bcb104b5afd0bfb49cbe30410ec5b8fadd5 (diff) | |
| parent | 7d920726a6fe5fe759828a5cca43452e30c50517 (diff) | |
| download | cmd2-git-7530674e171a57adc599740fb68eeac0313ee2ae.tar.gz | |
Merge pull request #226 from python-cmd2/comment_grammar
Improved documentation for how a user can modify comment grammar/style
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/freefeatures.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst index efb74316..e3787720 100644 --- a/docs/freefeatures.rst +++ b/docs/freefeatures.rst @@ -36,7 +36,7 @@ before it is passed to a ``do_`` method. By default, both Python-style and C-style comments are recognized; you may change this by overriding ``app.commentGrammars`` with a different pyparsing_ -grammar. +grammar (see the arg_print_ example for specifically how to to this). Comments can be useful in :ref:`scripts`, but would be pointless within an interactive session. @@ -52,6 +52,7 @@ be pointless within an interactive session. it was delicious! .. _pyparsing: http://pyparsing.wikispaces.com/ +.. _arg_print: https://github.com/python-cmd2/cmd2/blob/master/examples/arg_print.py Commands at invocation ====================== |