Merge pull request #13541 from bcongdon/fix/specgram-mode-docs

DOC: Remove mention of 'complex' mode in specgram docstring
matplotlib · Feb 28, 2019 · 79dad18 · 79dad18
2 parents 9a8df49 + 62e8b70
commit 79dad18
Showing 1 changed file with 4 additions and 5 deletions.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -7541,11 +7541,10 @@ def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
         %(PSD)s
 
         mode : {'default', 'psd', 'magnitude', 'angle', 'phase'}
-            What sort of spectrum to use.  Default is 'psd', which takes
-            the power spectral density.  'complex' returns the complex-valued
-            frequency spectrum.  'magnitude' returns the magnitude spectrum.
-            'angle' returns the phase spectrum without unwrapping.  'phase'
-            returns the phase spectrum with unwrapping.
+            What sort of spectrum to use.  Default is 'psd', which takes the
+            power spectral density.  'magnitude' returns the magnitude
+            spectrum.  'angle' returns the phase spectrum without unwrapping.
+            'phase' returns the phase spectrum with unwrapping.
 
         noverlap : int
             The number of points of overlap between blocks.  The