Add warning note to QgsLayoutPageCollection::shouldExportPage

nyalldawson · nyalldawson · commit e552ce62be25 · 2018-05-28T10:06:23.000+10:00
diff --git a/python/core/auto_generated/layout/qgslayoutpagecollection.sip.in b/python/core/auto_generated/layout/qgslayoutpagecollection.sip.in
@@ -100,6 +100,11 @@ Returns a list of layout items on the specified ``page`` index.
 %Docstring
 Returns whether the specified ``page`` number should be included in exports of the layouts.
 
+.. warning::
+
+   This will always return true unless the layout is being currently exported -- it cannot
+   be used in advance to determine whether a given page will be exported!
+
 .. seealso:: :py:func:`pageIsEmpty`
 %End
 
diff --git a/src/core/layout/qgslayoutpagecollection.h b/src/core/layout/qgslayoutpagecollection.h
@@ -138,6 +138,10 @@ class CORE_EXPORT QgsLayoutPageCollection : public QObject, public QgsLayoutSeri
 
     /**
      * Returns whether the specified \a page number should be included in exports of the layouts.
+     *
+     * \warning This will always return true unless the layout is being currently exported -- it cannot
+     * be used in advance to determine whether a given page will be exported!
+     *
      * \see pageIsEmpty()
      */
     bool shouldExportPage( int page ) const;
