DOC: stats: add a log base note to the docstring

scipy · Oct 19, 2013 · a58cef6 · a58cef6
1 parent b7aa678
commit a58cef6
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/scipy/stats/distributions.py b/scipy/stats/distributions.py
@@ -900,6 +900,14 @@ def entropy(self, *args, **kwds):
         scale : array_like, optional  (continuous distributions only).
             Scale parameter (default=1).
 
+        Notes
+        -----
+        Entropy is defined base `e`:
+        
+        >>> drv = rv_discrete(values=((0, 1), (0.5, 0.5)))
+        >>> np.allclose(drv.entropy(), np.log(2.0))
+        True
+
         """
         args, loc, scale = self._parse_args(*args, **kwds)
         # NB: for discrete distributions scale=1 by construction in _parse_args