[issue9302] Distutils document problem?
New submission from Ray.Allen
Changes by R. David Murray
Éric Araujo
Ray.Allen
Changes by Éric Araujo
R. David Murray
Éric Araujo
R. David Murray
Éric Araujo
Éric Araujo
Éric Araujo
ysj.ray
FYI, in one packaging doc I added one note instead of changing each cell: http://docs.python.org/dev/library/packaging.compiler#id6
I like this solution, it seems more concise and to the point. With this the doc need only one change:
--- a/Doc/distutils/apiref.rst Fri Apr 29 14:07:28 2011 +0800
+++ b/Doc/distutils/apiref.rst Thu Jun 16 23:15:12 2011 +0800
@@ -85,15 +85,15 @@
| *script_args* | Arguments to supply to the | a list of strings |
| | setup script | |
+--------------------+--------------------------------+-------------------------------------------------------------+
- | *options* | default options for the setup | a string |
+ | *options* | default options for the setup | a dictionary |
| | script | |
+--------------------+--------------------------------+-------------------------------------------------------------+
----------
_______________________________________
Python tracker
Éric Araujo
R. David Murray
Éric Araujo
Nor would I assume a plural option meant a list if the text says "a string".
Especially in distutils code where we can get space-separated or comma-separated values from the command line or config files. I’m in favor of using explicit “list of strings” wording now. ysj.ray, I understand from the “Done” comments on the review page that you have an updated patch somewhere; please upload and I’ll commit.
----------
_______________________________________
Python tracker
ysj.ray
I would not read [str] as implying a list of strings, FWIW.
help() on distutils.extension.Extension gives the parameters description like this: ...... sources: [string] ...... include_dirs: [string] ...... So I guess this style can be used as somewhere.
I’m in favor of using explicit “list of strings” wording now. ysj.ray, I understand from the “Done” comments on the review page that you have an updated patch somewhere; please upload and I’ll commit.
Ok, here is it. Thanks!
----------
Added file: http://bugs.python.org/file22391/issue_9302_2.diff
_______________________________________
Python tracker
Roundup Robot
Roundup Robot
Éric Araujo
participants (5)
-
R. David Murray
-
Ray.Allen
-
Roundup Robot
-
ysj.ray
-
Éric Araujo