diff options
Diffstat (limited to 'Doc/documenting')
| -rw-r--r-- | Doc/documenting/markup.rst | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index f85158b..a246d62 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -210,7 +210,20 @@ The directives are: .. describe:: opcode - Describes a Python bytecode instruction. + Describes a Python :term:`bytecode` instruction. + +.. describe:: cmdoption + + Describes a command line option or switch. Option argument names should be + enclosed in angle brackets. Example:: + + .. cmdoption:: -m <module> + + Run a module as a script. + +.. describe:: envvar + + Describes an environment variable that Python uses or defines. There is also a generic version of these directives: |