Skip to content

Commit 636d5cc

Browse files
DelazJnyalldawson
authored andcommittedJun 13, 2021
Use better reference to distance methods whether it's 3D or not
1 parent c04f6b5 commit 636d5cc

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed
 

‎python/core/auto_generated/geometry/qgspoint.sip.in

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,8 @@ Returns the Cartesian 2D distance between this point and another point. In certa
232232
cases it may be more appropriate to call the faster :py:func:`~QgsPoint.distanceSquared` method, e.g.,
233233
when comparing distances.
234234

235+
.. seealso:: :py:func:`distanceSquared`
236+
235237
.. versionadded:: 3.0
236238
%End
237239

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

266-
.. seealso:: :py:func:`distanceSquared`
268+
.. seealso:: :py:func:`distanceSquared3D`
267269

268270
.. versionadded:: 3.0
269271
%End
270272

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

279+
.. seealso:: :py:func:`distanceSquared3D`
280+
277281
.. versionadded:: 3.0
278282
%End
279283

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

286-
.. seealso:: :py:func:`distance`
290+
.. seealso:: :py:func:`distance3D`
287291

288292
.. versionadded:: 3.0
289293
%End
290294

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

297-
.. seealso:: :py:func:`distance`
301+
.. seealso:: :py:func:`distance3D`
298302

299303
.. versionadded:: 3.0
300304
%End

0 commit comments

Comments
 (0)
Please sign in to comment.