Opened 12 years ago

Last modified 12 years ago

#4155 new Bugs

function docstring signatures include self argument

Reported by: murrayc@… Owned by: Dave Abrahams
Milestone: Boost 1.43.0 Component: python USE GITHUB
Version: Boost 1.40.0 Severity: Problem
Keywords: Cc:

Description

boost::python generates Python signatures, but these include a useless (and confusing) arg1 arguments for the class's self. I don't believe that python documentation should generally show this because people know that they are class methods.

For example: http://www.murrayc.com/temp/glom_1_14_pydoc.html

I'm using boost::python 1.40 in Ubuntu Karmic. I can't find any list of what's changed since then.

Change History (1)

comment:1 by Amaury Forgeot d'Arc <amauryfa@…>, 12 years ago

I agree. FWIW, swig only says "self" with not indication for the type. For example:

>>> help(wx.Window.FindWindowByLabel)
Help on method FindWindowByLabel in module wx._core:

FindWindowByLabel(*args, **kwargs) unbound wx._core.Window method
    FindWindowByLabel(self, String label) -> Window

    Find a child of this window by label
Note: See TracTickets for help on using tickets.