Orange Forum • View topic - Docstrings

Docstrings

Discussions about new ideas and features you would like to see in Orange.
(Archived/read-only, please use our ticketing system for your wishes and their discussion.)
Forum rules
(Archived/read-only, please use our ticketing system for your wishes and their discussion.)

Docstrings

Postby detrout » Mon Aug 29, 2005 0:54

It would be nice if there were more docstrings in Orange.

I've grown accustomed to using python from IPython and its really nice to be able to interactively explore a package by following a procedure like:

In: import orngTest
In:orngTest.<TAB>
<List of orngTest's members>
In:orngTest.crossValidation?
Type: function
...
Definition: <function prototype>

But it would be really nice if the formal parameters were documented.

Also doing this would allow using API documentation generating tools like pydoc or epydoc to auto-create html browsable documentation.

Diane

Postby Janez » Tue May 16, 2006 14:08

Thanks for the suggestion. We won't go systematically through the existing code, but will add docstrings in the future.


Return to Wish List