diff --git a/bob/ip/facelandmarks/utils.py b/bob/ip/facelandmarks/utils.py index d9d3cd465af3d4500af505f5b6aad118fb5ee204..9c7ccb98c076f768c541dbaf282643d7004c1877 100644 --- a/bob/ip/facelandmarks/utils.py +++ b/bob/ip/facelandmarks/utils.py @@ -186,10 +186,10 @@ def _detect_multiple_landmarks_on_gray_image(data, top=0, min_quality=0.): Returns: - list: A list of named tuples of type :py:class:`.utils.Result`, each containing - the result of face detection and landmarks extracted from the input - image. - The list MAY BE EMPTY if no face is detected in the input image (data). + :py:class:`list`: A list of named tuples of type :py:class:`.utils.Result`, + each containing the result of face detection and landmarks extracted from + the input image. The list MAY BE EMPTY if no face is detected in the + input image (data). ''' @@ -278,9 +278,9 @@ def _detect_multiple_landmarks_on_color_image(data, top=0, min_quality=0.): Returns: - list: A list of named tuples of type :py:class:`.utils.Result`, each containing - the result of face detection and landmarks extracted from the input - image. + :py:class:`list`: A list of named tuples of type :py:class:`.utils.Result`, + each containing the result of face detection and landmarks extracted from + the input image. ''' @@ -313,9 +313,9 @@ def detect_landmarks(data, top=0, min_quality=0.): Returns: - list: A list of named tuples of type :py:class:`.utils.Result`, each containing - the result of face detection and landmarks extracted from the input - image. + :py:class:`list`: A list of named tuples of type :py:class:`.utils.Result`, + each containing the result of face detection and landmarks extracted from + the input image. ''' @@ -335,9 +335,9 @@ def draw_landmarks(data, results): dimensions, corresponding to a either a gray-scale or color image loaded with Bob. - results (list): A list of named tuples of type :py:class:`.utils.Result`, each - containing the result of face detection and landmarks extracted from the - input image. + results (:py:class:`list`): A list of named tuples of type + :py:class:`.utils.Result`, each containing the result of face detection + and landmarks extracted from the input image. ''' @@ -395,9 +395,9 @@ def save_landmarks(results, fname): Parameters: - results (list): A list of named tuples of type :py:class:`.utils.Result`, each - containing the result of face detection and landmarks extracted from the - input image. + results (:py:class:`list`): A list of named tuples of type + :py:class:`.utils.Result`, each containing the result of face detection + and landmarks extracted from the input image. fname (str): A path with the output filename diff --git a/doc/nitpick-exceptions.txt b/doc/nitpick-exceptions.txt index 6a5cf99416be345dfb2c382a81cb533e8a01e48d..21e54e64debbe1d792aed74efab96f1540d78c14 100644 --- a/doc/nitpick-exceptions.txt +++ b/doc/nitpick-exceptions.txt @@ -1 +1,3 @@ +# Solve some Python 2.7 misses on its documentation +py:class list py:class collections.namedtuple