[PyQt] [PATCH] Use provided docstrings for Qt signals

David Sansome me at davidsansome.com
Fri Feb 18 13:13:02 GMT 2011


I noticed that sip was ignoring my %Docstring directives for Qt
signals (methods and everything else work fine), and using its
automatically generated ones instead.

For example:

class SomeClass {
  signals:
    void SomeSignal();
%Docstring
Foo
%End
};

>>> SomeClass.SomeSignal.__doc__
'SomeClass.SomeSignal() [signal]'

I've attached a patch that fixes this and makes it use the docstring
from the %Docstring block instead if it's present (otherwise it will
fall back to the automatically generated one as before).

>>> SomeClass.SomeSignal.__doc__
'Foo [signal]'

David
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signal-docstrings.patch
Type: text/x-patch
Size: 968 bytes
Desc: not available
URL: <http://www.riverbankcomputing.com/pipermail/pyqt/attachments/20110218/b756ebc3/attachment.bin>


More information about the PyQt mailing list