Merge branch '29-cmc-documentation-os-not-consistent-with-the-reality' into 'master'

Updated CMC documentation

Closes #29

See merge request !35

bob/measure/__init__.py

@@ -271,29 +271,34 @@ def cmc(cmc_scores):
 
   .. note::
 
-     The CMC is not available for open set classification.  Please use the
+     The CMC is not available for open set classification. Please use the
      :py:func:`detection_identification_rate` and :py:func:`false_alarm_rate`
      instead.
 
 
-  Parameters:
-
-    cmc_scores (:py:class:`list`): A list in the format ``[(negatives,
-      positives), ...]`` containing the CMC scores loaded with one of the
-      functions (:py:func:`bob.measure.load.cmc_four_column` or
-      :py:func:`bob.measure.load.cmc_five_column`).
+  Parameters
+  ----------
 
-      Each pair contains the ``negative`` and the ``positive`` scores for **one
-      probe item**.  Each pair can contain up to one empty array (or ``None``),
-      i.e., in case of open set recognition.
+  cmc_scores : :py:class:`list`
+    A list in the format ``[(negatives, positives), ...]`` containing the CMC
+    scores loaded with one of the functions
+    :py:func:`bob.measure.load.cmc_four_column`,
+    :py:func:`bob.measure.load.cmc_five_column`, or
+    :py:func:`bob.measure.load.cmc`.
 
+    Each pair contains the ``negative`` and the ``positive`` scores for **one
+    probe item**.  Each pair can contain up to one empty array (or ``None``),
+    i.e., in case of open set recognition.
 
-  Returns:
 
-    array: A 2D float array representing the CMC curve, with the Rank in the
-    first column and the number of correctly classified clients (in this
-    rank) in the second column.
+  Returns
+  -------
 
+  1D :py:class:`numpy.ndarray` of `float`
+    A 1D float array representing the CMC curve.
+    The rank 1 recognition rate can be found in ``array[0]``, rank 2 rate in
+    ``array[1]``, and so on. The number of ranks (``array.shape[0]``) is the
+    number of gallery items. Values are in range ``[0,1]``.
   """
 
   # If no scores are given, we cannot plot anything