<div dir="auto">Thanks a lot Nyall for the great work<div dir="auto"><br></div><div dir="auto">Cheers Marco </div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Mon, 16 Sept 2024, 01:56 Nyall Dawson via QGIS-PSC, <<a href="mailto:qgis-psc@lists.osgeo.org">qgis-psc@lists.osgeo.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi PSC,<br>
<br>
Thanks for the opportunity to do further work on the PyQGIS<br>
documentation and further improve this vital resource. Here's a quick<br>
summary of the improvements made during this round:<br>
<br>
1. Correct documentation is now shown for signals. Previously, we'd<br>
just get a generic useless string for all signals (see eg<br>
<a href="https://qgis.org/pyqgis/3.34/core/QgsBookmarkManager.html#qgis.core.QgsBookmarkManager.bookmarkAboutToBeAdded" rel="noreferrer noreferrer" target="_blank">https://qgis.org/pyqgis/3.34/core/QgsBookmarkManager.html#qgis.core.QgsBookmarkManager.bookmarkAboutToBeAdded</a><br>
). Now, the site shows the proper documentation and signature for all<br>
signals. (Partially visible at<br>
<a href="https://qgis.org/pyqgis/master/core/QgsBookmarkManager.html#qgis.core.QgsBookmarkManager.bookmarkAboutToBeAdded" rel="noreferrer noreferrer" target="_blank">https://qgis.org/pyqgis/master/core/QgsBookmarkManager.html#qgis.core.QgsBookmarkManager.bookmarkAboutToBeAdded</a>,<br>
with the signature display pending the next scheduled weekly update of<br>
the documentation site)<br>
<br>
2. Overloaded method documentation is now correctly displayed. Compare<br>
before (eg <a href="https://web.archive.org/web/20230202072455/https://qgis.org/pyqgis/master/core/QgsLayoutExporter.html#qgis.core.QgsLayoutExporter.exportToPdf" rel="noreferrer noreferrer" target="_blank">https://web.archive.org/web/20230202072455/https://qgis.org/pyqgis/master/core/QgsLayoutExporter.html#qgis.core.QgsLayoutExporter.exportToPdf</a>)<br>
where the two exportToPdf methods are confusingly displayed, vs now:<br>
<a href="https://qgis.org/pyqgis/master/core/QgsLayoutExporter.html#qgis.core.QgsLayoutExporter.exportToPdf" rel="noreferrer noreferrer" target="_blank">https://qgis.org/pyqgis/master/core/QgsLayoutExporter.html#qgis.core.QgsLayoutExporter.exportToPdf</a><br>
. This fix also ensures that the full parameters and return type<br>
documentation are visible for all overloads.<br>
<br>
3. Qt classes in the "base class" list and inheritance diagrams now<br>
link across to the Qt docs. See eg<br>
<a href="https://qgis.org/pyqgis/master/core/QgsFieldModel.html" rel="noreferrer noreferrer" target="_blank">https://qgis.org/pyqgis/master/core/QgsFieldModel.html</a><br>
<br>
4. Function objects are now properly documented, see eg<br>
<a href="https://qgis.org/pyqgis/master/processing/createAlgorithmDialog.html" rel="noreferrer noreferrer" target="_blank">https://qgis.org/pyqgis/master/processing/createAlgorithmDialog.html</a><br>
<br>
5. Attributes in structs are now correctly documented. See eg missing<br>
documentation in<br>
<a href="https://qgis.org/pyqgis/3.38/core/QgsLayoutExporter.html#qgis.core.QgsLayoutExporter.ImageExportSettings" rel="noreferrer noreferrer" target="_blank">https://qgis.org/pyqgis/3.38/core/QgsLayoutExporter.html#qgis.core.QgsLayoutExporter.ImageExportSettings</a><br>
. (The fixed documentation is pending the next weekly update)<br>
<br>
Thanks again!<br>
Nyall<br>
_______________________________________________<br>
QGIS-PSC mailing list<br>
<a href="mailto:QGIS-PSC@lists.osgeo.org" target="_blank" rel="noreferrer">QGIS-PSC@lists.osgeo.org</a><br>
<a href="https://lists.osgeo.org/mailman/listinfo/qgis-psc" rel="noreferrer noreferrer" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-psc</a><br>
</blockquote></div>