Skip to content

Commit a3f14df

Browse files
committedJun 26, 2017
Update docstrings
1 parent e7f5052 commit a3f14df

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed
 

‎python/core/geometry/qgslinestring.sip

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ class QgsLineString: QgsCurve
7575
%Docstring
7676
Returns the z-coordinate of the specified node in the line string.
7777
\param index index of node, where the first node in the line is 0
78-
:return: z-coordinate of node, or 0.0 if index is out of bounds or the line
78+
:return: z-coordinate of node, or ``nan`` if index is out of bounds or the line
7979
does not have a z dimension
8080
.. seealso:: setZAt()
8181
:rtype: float
@@ -85,7 +85,7 @@ class QgsLineString: QgsCurve
8585
%Docstring
8686
Returns the m value of the specified node in the line string.
8787
\param index index of node, where the first node in the line is 0
88-
:return: m value of node, or 0.0 if index is out of bounds or the line
88+
:return: m value of node, or ``nan`` if index is out of bounds or the line
8989
does not have m values
9090
.. seealso:: setMAt()
9191
:rtype: float

‎src/core/geometry/qgslinestring.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,15 @@ class CORE_EXPORT QgsLineString: public QgsCurve
8383

8484
/** Returns the z-coordinate of the specified node in the line string.
8585
* \param index index of node, where the first node in the line is 0
86-
* \returns z-coordinate of node, or 0.0 if index is out of bounds or the line
86+
* \returns z-coordinate of node, or ``nan`` if index is out of bounds or the line
8787
* does not have a z dimension
8888
* \see setZAt()
8989
*/
9090
double zAt( int index ) const;
9191

9292
/** Returns the m value of the specified node in the line string.
9393
* \param index index of node, where the first node in the line is 0
94-
* \returns m value of node, or 0.0 if index is out of bounds or the line
94+
* \returns m value of node, or ``nan`` if index is out of bounds or the line
9595
* does not have m values
9696
* \see setMAt()
9797
*/

0 commit comments

Comments
 (0)
Please sign in to comment.