adding a docstring to an instancemethod

[jelle]

Hi,

I'm working on documenting wrapped C++ methods.
The thing is that I'd like to add docstrings to a method, but python
won't allow me to:
TypeError: attribute '__doc__' of 'instancemethod' objects is not
writable

What would be an easy way to do so? I'd like to overload the .__doc__,
rather than wrapping it in a class.

Cheers,

-jelle

 

[Gabriel Genellina]

I'm working on documenting wrapped C++ methods.
The thing is that I'd like to add docstrings to a method, but python
won't allow me to:
TypeError: attribute '__doc__' of 'instancemethod' objects is not
writable

Set the __doc__ on the *function* from which you build the instance method.

 

[jelle]

Set the __doc__ on the *function* from which you build the instance method.

Thanks for you reply Gabriel,
Though setting the docstring to the functions wouldn't be an option
for me.
The thing is that I have a

wrappedCppModule.Class.Method I'd like to give a docstring, so there's
no prior function to refer to.

Thanks,

-jelle

 

[jelle]

Hi Gabriella,

thanks for pointing me in the right direction:
eo.eoTruncatedSelectOne.setup.im_func.func_doc = 'method string goes
here'
works beautifully!

cheers,

-jelle

 

[Gabriel Genellina]

Hi Gabriella,
thanks for pointing me in the right direction:

Twice in a week... I'll have to revise my own masculinity...

 

[Neil Cerutti]

Twice in a week... I'll have to revise my own masculinity...

The trumpet shall sound!

 

[Steven D'Aprano]

Twice in a week... I'll have to revise my own masculinity...

You need to spit and fart a lot in your posts, and talk about sport.

Either that, or change your name to Sylar and eat people's brains.