__doc__ strings

[ericvrp@…]

For most Python modules and packages html documentation can be generated automatically by a tool that is included in python 2.1 . Being able to set the docstring would be a step in the right direction to make boost.python compatible with pydoc.py .

[blais]

Logged In: YES 
user_id=10996

I am already able to set the docstring with the following
bit of code in the module initialization:

module.add( boost::python::make_ref( help() ), "__doc__");

where help() is a function that returns a string.

Is there a way to set docstrings of functions though?

[david_abrahams]

Logged In: YES 
user_id=52572

At present, I don't think there is.
You would need to modify all of Boost.Python's function 
classes to hold a doc string, and modify all of the def() 
functions to accept an optional doc string. I started this 
project, but realized that I was crazy after having stayed 
up for 36 hours straight working on Thursday and Friday. If 
you're interested in the broken state of the source, it's 
attached here.

If you get it to work, please submit a patch for the 
completed code.

Thanks,
Dave

[Dave Abrahams]

Partially-completed work on function docstrings

[Dave Abrahams]

I think now that we have Boost.Parameter this job could become much easier.

[Dave Abrahams]

Sorry it's been so long, but I'm confused about exactly what's missing here. It looks to me like the def() functions already support supplying a docstring. If there's still a real problem, please reopen this bug. In the meantime, I'm closing it.