Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
m-kuhn committed Jun 26, 2017
1 parent e7f5052 commit a3f14df
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions python/core/geometry/qgslinestring.sip
Expand Up @@ -75,7 +75,7 @@ class QgsLineString: QgsCurve
%Docstring
Returns the z-coordinate of the specified node in the line string.
\param index index of node, where the first node in the line is 0
:return: z-coordinate of node, or 0.0 if index is out of bounds or the line
:return: z-coordinate of node, or ``nan`` if index is out of bounds or the line
does not have a z dimension
.. seealso:: setZAt()
:rtype: float
Expand All @@ -85,7 +85,7 @@ class QgsLineString: QgsCurve
%Docstring
Returns the m value of the specified node in the line string.
\param index index of node, where the first node in the line is 0
:return: m value of node, or 0.0 if index is out of bounds or the line
:return: m value of node, or ``nan`` if index is out of bounds or the line
does not have m values
.. seealso:: setMAt()
:rtype: float
Expand Down
4 changes: 2 additions & 2 deletions src/core/geometry/qgslinestring.h
Expand Up @@ -83,15 +83,15 @@ class CORE_EXPORT QgsLineString: public QgsCurve

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

/** Returns the m value of the specified node in the line string.
* \param index index of node, where the first node in the line is 0
* \returns m value of node, or 0.0 if index is out of bounds or the line
* \returns m value of node, or ``nan`` if index is out of bounds or the line
* does not have m values
* \see setMAt()
*/
Expand Down

0 comments on commit a3f14df

Please sign in to comment.