Dox

qgis · May 4, 2021 · 928e3ee · 928e3ee
1 parent 208c51b
commit 928e3ee
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -1409,8 +1409,13 @@ on the boundary of the inscribed circle.
 
 This method requires QGIS builds based on GEOS 3.9 or later.
 
+.. warning::
+
+   the ``tolerance`` value must be a value greater than 0, or the algorithm may never converge on a solution
+
 :raises :: py:class:`QgsNotSupportedException` on QGIS builds based on GEOS 3.8 or earlier.
 
+
 .. versionadded:: 3.20
 %End
 

diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -1411,6 +1411,8 @@ class CORE_EXPORT QgsGeometry
      *
      * This method requires QGIS builds based on GEOS 3.9 or later.
      *
+     * \warning the \a tolerance value must be a value greater than 0, or the algorithm may never converge on a solution
+     *
      * \throws QgsNotSupportedException on QGIS builds based on GEOS 3.8 or earlier.
      *
      * \since QGIS 3.20

diff --git a/src/core/geometry/qgsgeos.h b/src/core/geometry/qgsgeos.h
@@ -338,6 +338,8 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
      *
      * This method requires a QGIS build based on GEOS 3.9 or later.
      *
+     * \warning the \a tolerance value must be a value greater than 0, or the algorithm may never converge on a solution
+     *
      * \throws QgsNotSupportedException on QGIS builds based on GEOS 3.8 or earlier.
      *
      * \since QGIS 3.20