Adjust docstring in qgsgeometryutils_base.h

qgis · May 23, 2024 · 2768e41 · 2768e41
1 parent 91a5382
commit 2768e41
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in
@@ -23,7 +23,7 @@ Convenience functions for geometry utils.
 
     static double sqrDistance3D( double x1, double y1, double z1, double x2, double y2, double z2 ) /HoldGIL/;
 %Docstring
-Returns the squared 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and (``z2``, ``z2``).
+Returns the squared 3D distance between (``x1``, ``y1``, ``z1``) and (``x2``, ``y2``, ``z2``).
 
 .. warning::
 
@@ -34,7 +34,7 @@ Returns the squared 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and (
 
     static double distance3D( double x1, double y1, double z1, double x2, double y2, double z2 ) /HoldGIL/;
 %Docstring
-Returns the 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and (``z2``, ``z2``).
+Returns the 3D distance between (``x1``, ``y1``, ``z1``) and (``x2``, ``y2``, ``z2``).
 
 .. warning::
 

diff --git a/python/core/auto_generated/geometry/qgsgeometryutils_base.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils_base.sip.in
@@ -23,7 +23,7 @@ Convenience functions for geometry utils.
 
     static double sqrDistance3D( double x1, double y1, double z1, double x2, double y2, double z2 ) /HoldGIL/;
 %Docstring
-Returns the squared 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and (``z2``, ``z2``).
+Returns the squared 3D distance between (``x1``, ``y1``, ``z1``) and (``x2``, ``y2``, ``z2``).
 
 .. warning::
 
@@ -34,7 +34,7 @@ Returns the squared 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and (
 
     static double distance3D( double x1, double y1, double z1, double x2, double y2, double z2 ) /HoldGIL/;
 %Docstring
-Returns the 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and (``z2``, ``z2``).
+Returns the 3D distance between (``x1``, ``y1``, ``z1``) and (``x2``, ``y2``, ``z2``).
 
 .. warning::
 

diff --git a/src/core/geometry/qgsgeometryutils_base.h b/src/core/geometry/qgsgeometryutils_base.h
@@ -32,15 +32,15 @@ class CORE_EXPORT QgsGeometryUtilsBase
   public:
 
     /**
-     * Returns the squared 3D distance between (\a x1, \a y1), (\a x2, \a y2) and (\a z2, \a z2).
+     * Returns the squared 3D distance between (\a x1, \a y1, \a z1) and (\a x2, \a y2, \a z2).
      *
      * \warning No check is done if z contains NaN value. This is the caller's responsibility.
      * \since QGIS 3.36
      */
     static double sqrDistance3D( double x1, double y1, double z1, double x2, double y2, double z2 ) SIP_HOLDGIL {return ( x1 - x2 ) * ( x1 - x2 ) + ( y1 - y2 ) * ( y1 - y2 ) + ( z1 - z2 ) * ( z1 - z2 ); }
 
     /**
-     * Returns the 3D distance between (\a x1, \a y1), (\a x2, \a y2) and (\a z2, \a z2).
+     * Returns the 3D distance between (\a x1, \a y1, \a z1) and (\a x2, \a y2, \a z2).
      *
      * \warning No check is done if z contains NaN value. This is the caller's responsibility.
      * \since QGIS 3.36