search

pygobject / pgi-docgen

API Documentation Generator for PyGObject
https://lazka.github.io/pgi-docs/
GNU Lesser General Public License v2.1
129 stars 36 forks source link

Methods overriden with strip_boolean_result show wrong return description/type #102

Closed sjohannes closed 8 years ago

sjohannes commented 9 years ago

PyGObject overrides a number of methods that return (success:bool, out1, out2, ...) with strip_boolean_result (defined in gi/overrides/__init__.py), making them instead return (out1, out2, ...) on success and None on failure.

pgi-docgen doesn't seem to recognise this (or at least not all of the instances where this occurs). For example, the Gtk.Widget.translate_coordinates documentation indicates that it returns (bool, int, int), which looks like it should be correct, except PyGObject overrides the method to return either (int, int) or None instead.

lazka commented 9 years ago

Related: #55

lazka commented 8 years ago

Fixed