Commit df755b5e authored by André Anjos's avatar André Anjos 💬

Fix documentation errors

parent 36268abd
Pipeline #4798 passed with stages
in 11 minutes and 42 seconds
......@@ -21,7 +21,7 @@ static bob::extension::FunctionDoc s_point = bob::extension::FunctionDoc(
"This method can draw a point in either gray-scale (2D) or color images. "
"Images have to be :py:class:`numpy.ndarray`'s with either ``uint8``, "
"``uint16`` or ``float64`` data type. Trying to access outside the image "
"range will raise a :py:class:`RuntimeError`.\n"
"range will raise a :py:exc:`RuntimeError`.\n"
"\n"
"In case you pass a 2D array representing a gray-scale image, this function "
"expects you pass a single scalar as a value for the input parameter "
......@@ -100,7 +100,7 @@ static bob::extension::FunctionDoc s_cross = bob::extension::FunctionDoc(
"point ``p`` and will have the ``radius`` defined. Images have to be "
":py:class:`numpy.ndarray`'s with either ``uint8``, ``uint16`` or "
"``float64`` data type. Trying to access outside the image range will "
"raise a :py:class:`RuntimeError`.\n"
"raise a :py:exc:`RuntimeError`.\n"
"\n"
"In case you pass a 2D array representing a gray-scale image, this function "
"expects you pass a single scalar as a value for the input parameter "
......@@ -130,7 +130,7 @@ static bob::extension::FunctionDoc s_plus = bob::extension::FunctionDoc(
"point ``p`` and will have the ``radius`` defined. Images have to be "
":py:class:`numpy.ndarray`'s with either ``uint8``, ``uint16`` or "
"``float64`` data type. Trying to access outside the image range will "
"raise a :py:class:`RuntimeError`.\n"
"raise a :py:exc:`RuntimeError`.\n"
"\n"
"In case you pass a 2D array representing a gray-scale image, this function "
"expects you pass a single scalar as a value for the input parameter "
......
# Not properly documented on Python 2.7 manual
py:exc RuntimeError
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment