[Qgis-developer] Sip flag to generate docstrings

[Gary Sherman]

I would like to propose that we add the -o flag to this line in CMakeLists.txt:

SET(SIP_EXTRA_OPTIONS ${PYQT4_SIP_FLAGS} -o)

This tells sip to automatically generate docstrings for all classes and methods. These in turn can be accessed from Python. 

When using the IPython plugin this provides valuable information when constructing a statement.

I have tested this on Linux (Ubuntu) and OS X and it works fine. 

The -o flag was added to sip at 4.10. Currently the INSTALL instructions specify sip 4.8 as the minimum version so that would have to be changed.

Can someone test this on the Windows build? Any downsides to adding the flag?

-gary

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Gary Sherman
GeoApt LLC
  http://geoapt.com
Founder, Quantum GIS
Chair, QGIS PSC
Book:
  http://geospatialdesktop.com
"We work virtually everywhere"
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=