[PyQt] Documenting signals

Phil Thompson phil at riverbankcomputing.com
Wed Sep 17 11:23:04 BST 2008

On Wed, 17 Sep 2008 12:07:29 +0200, Georg Altmann <george at george-net.de>
> Hi,
> I'm new to PyQt(4) and python in general. Is there a good way to 
> document signals of a class in the doc string?
> Something like this:
> class MyClass(QObject):
>      """My nifty class.
>      @signal myNiftySignal() This signal will be emitted when the object
>      did something nifty."""
> Or can I add dummy methods and document them as signals?

You can use __pyqtSignals__ to define them as Qt signals and add a comment


More information about the PyQt mailing list