Skip to content
Permalink
Browse files
Use better reference to distance methods whether it's 3D or not
  • Loading branch information
DelazJ authored and nyalldawson committed Jun 13, 2021
1 parent c04f6b5 commit 636d5cc43d7f3f9439d280cdf4f4d7ce853ef4e8
Showing with 13 additions and 9 deletions.
  1. +13 −9 python/core/auto_generated/geometry/qgspoint.sip.in
@@ -232,6 +232,8 @@ Returns the Cartesian 2D distance between this point and another point. In certa
cases it may be more appropriate to call the faster :py:func:`~QgsPoint.distanceSquared` method, e.g.,
when comparing distances.

.. seealso:: :py:func:`distanceSquared`

.. versionadded:: 3.0
%End

@@ -260,41 +262,43 @@ distances where the extra expense of calling :py:func:`~QgsPoint.distance` is no
double distance3D( double x, double y, double z ) const /HoldGIL/;
%Docstring
Returns the Cartesian 3D distance between this point and a specified x, y, z coordinate. In certain
cases it may be more appropriate to call the faster :py:func:`~QgsPoint.distanceSquared` method, e.g.,
cases it may be more appropriate to call the faster :py:func:`~QgsPoint.distanceSquared3D` method, e.g.,
when comparing distances.

.. seealso:: :py:func:`distanceSquared`
.. seealso:: :py:func:`distanceSquared3D`

.. versionadded:: 3.0
%End

double distance3D( const QgsPoint &other ) const /HoldGIL/;
%Docstring
Returns the Cartesian 3D distance between this point and another point. In certain
cases it may be more appropriate to call the faster :py:func:`~QgsPoint.distanceSquared` method, e.g.,
cases it may be more appropriate to call the faster :py:func:`~QgsPoint.distanceSquared3D` method, e.g.,
when comparing distances.

.. seealso:: :py:func:`distanceSquared3D`

.. versionadded:: 3.0
%End

double distanceSquared3D( double x, double y, double z ) const /HoldGIL/;
%Docstring
Returns the Cartesian 3D squared distance between this point and a specified x, y, z coordinate. Calling
this is faster than calling :py:func:`~QgsPoint.distance`, and may be useful in use cases such as comparing
distances where the extra expense of calling :py:func:`~QgsPoint.distance` is not required.
this is faster than calling :py:func:`~QgsPoint.distance3D`, and may be useful in use cases such as comparing
distances where the extra expense of calling :py:func:`~QgsPoint.distance3D` is not required.

.. seealso:: :py:func:`distance`
.. seealso:: :py:func:`distance3D`

.. versionadded:: 3.0
%End

double distanceSquared3D( const QgsPoint &other ) const /HoldGIL/;
%Docstring
Returns the Cartesian 3D squared distance between this point and another point. Calling
this is faster than calling :py:func:`~QgsPoint.distance`, and may be useful in use cases such as comparing
distances where the extra expense of calling :py:func:`~QgsPoint.distance` is not required.
this is faster than calling :py:func:`~QgsPoint.distance3D`, and may be useful in use cases such as comparing
distances where the extra expense of calling :py:func:`~QgsPoint.distance3D` is not required.

.. seealso:: :py:func:`distance`
.. seealso:: :py:func:`distance3D`

.. versionadded:: 3.0
%End

0 comments on commit 636d5cc

Please sign in to comment.