[docs] [issue11827] mention of list2cmdline() in docs of subprocess.Popen

Eli Bendersky report at bugs.python.org
Mon Apr 11 10:38:17 CEST 2011


New submission from Eli Bendersky <eliben at gmail.com>:

The documentation of subprocess.Popen mentions a function named list2cmdline():

----
  On Windows: the Popen class uses CreateProcess() to execute the child program, which operates on strings. If args is a sequence, it will be converted to a string using the list2cmdline() method. Please note that not all MS Windows applications interpret the command line the same way: list2cmdline() is designed for applications using the same rules as the MS C runtime.
----

I find this rather opaque and useless. list2cmdline() in subprocess is publicly accessible (doesn't begin with underscores) but it isn't documented.

The solution can be one of the following:

1. Document list2cmdline in the docs of subprocess, making the reference to is useful
2. Don't mention list2cmdline and instead mention what it does with the command-line list

----------
assignee: docs at python
components: Documentation
messages: 133507
nosy: docs at python, eli.bendersky
priority: normal
severity: normal
stage: needs patch
status: open
title: mention of list2cmdline() in docs of subprocess.Popen
type: behavior
versions: Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue11827>
_______________________________________


More information about the docs mailing list