Update docstrings

This commit is contained in:
Matthias Kuhn 2017-06-26 00:39:40 +02:00
parent e7f50524b8
commit a3f14df367
2 changed files with 4 additions and 4 deletions

View File

@ -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
@ -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

View File

@ -83,7 +83,7 @@ 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()
*/
@ -91,7 +91,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
/** 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()
*/