Boost C++ Libraries: Ticket #918: doc strings

blais — Sat, 22 Sep 2001 00:20:35 GMT

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 — Sat, 22 Sep 2001 17:45:39 GMT

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

owner, status, description changed; severity set

Dave Abrahams — Tue, 03 Jul 2007 14:31:13 GMT

owner changed from david_abrahams to Dave Abrahams
status assigned → new
description modified (diff)
severity → Showstopper

status, reporter, description, version changed; milestone set

Dave Abrahams — Tue, 03 Jul 2007 14:50:17 GMT

status new → assigned
reporter changed from ericvrp to ericvrp@…
description modified (diff)
version None → release 1.34.0
milestone → Boost 1.35.0

attachment set

Dave Abrahams — Tue, 03 Jul 2007 14:51:31 GMT

attachment → function-docstrings.tgz

Partially-completed work on function docstrings

severity changed

Dave Abrahams — Tue, 03 Jul 2007 14:52:21 GMT

severity Showstopper → Problem

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

status, resolution changed; cc set

Dave Abrahams — Thu, 11 Jun 2009 20:56:26 GMT

cc ericvrp@… added
status assigned → closed
resolution None → invalid