search

plasmodic / ecto

ecto is a dynamically configurable Directed Acyclic processing Graph (DAG) framework.
http://ecto.willowgarage.com/
BSD 3-Clause "New" or "Revised" License
98 stars 37 forks source link

Blackbox ignores given doc string when forwarding #203

Closed stwirth closed 12 years ago

stwirth commented 12 years ago

When forwarding an output of a Blackbox a doc string can be defined: test/scripts/blackbox.py:52:

o.forward('value', cell_name='inc', cell_key='out', doc='New docs')

However, the output of __doc__ does not contain this string. The name of the output is changed (here from 'out' to 'value') but the doc is still the original from the cell. See the output when running the script:

MyBlackBox (ecto::module):

 A simple black box that doesn't really do anything.

Parameters:
 - amount [double] default = 1
    Amount to increment by.

 - fail [boost::python::api::object] default = True
    Should i fail or should i go.

 - start [double] default = 10
    My starting value.

 - step [double] default = 3
    The step with which i generate integers.

Outputs:
 - value [double]
    output

The string "New docs" does not appear below "Outputs".

vrabaud commented 12 years ago

Thx for reporting. Issue fixed in fc1d1b906f319b306c4d9c51d7a3efa8bc7631f1