New submission from Nick Coghlan <ncogh...@gmail.com>:

Many typical subprocess use cases can now be handled simply via the convenience 
functions:

  subprocess.call()
  subprocess.check_call()
  subprocess.check_output()

However, readers of the documentation could be forgiven for not realising that, 
since the docs dive right in with Popen() and will scare most readers away in 
search of more user friendly APIs (or even other languages).

The module documentation should be reordered to introduce the helper function 
first, then Popen afterwards.

The "subprocess replacements" [1] section would ideally help address this, but 
it hasn't been updated to use the convenience function, instead using confusing 
direct calls to Popen.

[1] http://docs.python.org/library/subprocess.html#subprocess-replacements

----------
assignee: docs@python
components: Documentation
messages: 146059
nosy: docs@python, ncoghlan
priority: normal
severity: normal
stage: needs patch
status: open
title: subprocess docs should use emphasise convenience functions
versions: Python 2.7, Python 3.2, Python 3.3

_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue13237>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to