doc: extend

cophi-wue · Sep 14, 2018 · a07dba4 · a07dba4
1 parent aed9616
commit a07dba4
Showing 1 changed file with 18 additions and 6 deletions.
diff --git a/src/cophi/model.py b/src/cophi/model.py
@@ -273,8 +273,12 @@ def bootstrap(self, measure="ttr", window=1000, **kwargs):
         """Calculate complexity with a sliding window.
 
         Parameters:
-            measure (str): Measure to use, see `help(cophi)`
-                for available metrics (optional).
+            measure (str): Measure to use, possible values are
+                'ttr', 'guiraud_r', 'herdan_c', 'dugast_k',
+                'maas_a2', 'dugast_u', 'tuldava_ln', 'brunet_w',
+                'cttr', 'summer_s', 'honore_h', 'sichel_s',
+                'michea_m', 'entropy', 'yule_k', 'simpsons_d',
+                'herdan_vm', or 'orlov_z'.
             window (int): Size of sliding window (optional).
             **kwargs: Additional parameters for
                 :func:`cophi.complexity.orlov_z` (optional).
@@ -288,8 +292,12 @@ def complexity(self, measure="ttr", window=None, **kwargs):
         """Calculate complexity, optionally with a sliding window.
 
         Parameters:
-            measure (str): Measure to use, see `help(cophi)` for
-                available metrics (optional).
+            measure (str): Measure to use, possible values are
+                'ttr', 'guiraud_r', 'herdan_c', 'dugast_k',
+                'maas_a2', 'dugast_u', 'tuldava_ln', 'brunet_w',
+                'cttr', 'summer_s', 'honore_h', 'sichel_s',
+                'michea_m', 'entropy', 'yule_k', 'simpsons_d',
+                'herdan_vm', or 'orlov_z'.
             window (int): Size of sliding window (optional).
             **kwargs: Additional parameters for
                 :func:`cophi.complexity.orlov_z` (optional).
@@ -505,8 +513,12 @@ def complexity(self, window=1000, measure="ttr"):
         """Calculate complexity for each document with a sliding window.
 
         Parameters:
-            measure (str): Measure to use, see `help(cophi)` for
-                available metrics (optional).
+            measure (str): Measure to use, possible values are
+                'ttr', 'guiraud_r', 'herdan_c', 'dugast_k',
+                'maas_a2', 'dugast_u', 'tuldava_ln', 'brunet_w',
+                'cttr', 'summer_s', 'honore_h', 'sichel_s',
+                'michea_m', 'entropy', 'yule_k', 'simpsons_d',
+                'herdan_vm', or 'orlov_z'.
             window (int): Size of sliding window (optional).
             **kwargs: Additional parameters for
                 :func:`cophi.complexity.orlov_z` (optional).