[Python-checkins] r71634 - in python/branches/release30-maint:Doc/library/subprocess.rst

[Raymond Hettinger]

Stylistically, we should strongly prefer in-line comments and notes to the ".. warning" directives.

Python is not nitroglycerin.  We shouldn't fill our docs with big red warning boxes
creating the impression that every construct is dangerous, broken, or a complete hack.

Instead, it is better to show examples of correct usage, document what a
function actually does and note its limitations when necessary.


[r.david.murray]

> +   .. warning::
> +
> +      When replacing the environment you must provide any variables
> +      required for the program to execute.  On Windows, in order to run
> +      a side-by-side assembly the specified *env* must include a valid
> +      :envvar:`SystemRoot`.
> +