add a warning

qgis · Apr 29, 2021 · 4231134 · 4231134
1 parent dcfa1bd
commit 4231134
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in
@@ -754,6 +754,12 @@ A Z dimension is added to ``point`` if one of the point in the list
 
 :return: ``True`` if the point is updated, ``False`` otherwise
 
+.. warning::
+
+   This method does not copy the z value of the coordinate from the
+   points whose z value is closest to the original x/y point, but only the first one found.
+
+
 .. versionadded:: 3.0
 %End
 
@@ -768,6 +774,12 @@ updated with the first M value found in list ``points``.
 
 :return: ``True`` if the point is updated, ``False`` otherwise
 
+.. warning::
+
+   This method does not copy the m value of the coordinate from the
+   points whose m value is closest to the original x/y point, but only the first one found.
+
+
 .. versionadded:: 3.20
 %End
 

diff --git a/src/core/geometry/qgsgeometryutils.h b/src/core/geometry/qgsgeometryutils.h
@@ -776,6 +776,9 @@ class CORE_EXPORT QgsGeometryUtils
      * \param point The point to update with Z dimension and value.
      * \returns TRUE if the point is updated, FALSE otherwise
      *
+     * \warning This method does not copy the z value of the coordinate from the
+     * points whose z value is closest to the original x/y point, but only the first one found.
+     *
      * \since QGIS 3.0
      */
     static bool setZValueFromPoints( const QgsPointSequence &points, QgsPoint &point );
@@ -789,6 +792,9 @@ class CORE_EXPORT QgsGeometryUtils
      * \param point The point to update with M dimension and value.
      * \returns TRUE if the point is updated, FALSE otherwise
      *
+     * \warning This method does not copy the m value of the coordinate from the
+     * points whose m value is closest to the original x/y point, but only the first one found.
+     *
      * \since QGIS 3.20
      */
     static bool setMValueFromPoints( const QgsPointSequence &points, QgsPoint &point );