goerz / gc3pie

Automatically exported from code.google.com/p/gc3pie
0 stars 0 forks source link

Incorrect comment in Application class #455

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
2.2.2 version (SVN $Revision: 3979 $) of GC3Pie

The comment for the input parameters of the Application class says:
`environment`
      a list of pairs `(name, value)`: the
      environment variable whose name is given by the contents of
      the string `name` will be defined as the content of string
      `value` (i.e., as if "export name=value" was executed prior
      to starting the application).  Alternately, one can pass in
      a list of strings of the form "name=value".

However, when I passed a list into the environment Application parameter it 
didn't like it. It wants a dict of values, not a list. The comment should read:
`environment`
      a dictionary of `key:value` pairs: the
      environment variable whose name is given by the contents of
      the string `key` will be defined as the content of string
      `value` (i.e., as if "export name=value" was executed prior
      to starting the application).  Alternately, one can pass in
      a list of strings of the form "name=value".

Where the comment is:
https://code.google.com/p/gc3pie/source/browse/trunk/gc3pie/gc3libs/__init__.py#
676

Original issue reported on code.google.com by markjmon...@gmail.com on 5 Aug 2014 at 1:45

GoogleCodeExporter commented 9 years ago
Thanks for reporting!  I have clarified the docstring in SVN r3894.

Can you please check if the documentation is now satisfactory and,
if so, close the issue by setting the status to "Fixed"?

Original comment by riccardo.murri@gmail.com on 5 Aug 2014 at 10:20

GoogleCodeExporter commented 9 years ago
Fixed in release 2.2.3

Original comment by riccardo.murri@gmail.com on 19 Aug 2014 at 8:47