adafruit / circuitpython

CircuitPython - a Python implementation for teaching coding with microcontrollers
https://circuitpython.org
Other
4.07k stars 1.2k forks source link

ulab documentation mentions nonexistent `ulab.spectrum` #5833

Closed Thynix closed 1 year ago

Thynix commented 2 years ago

At least as of Adafruit CircuitPython 7.1.0, places like ulab.numpy.fft documentation refer to a nonexistent "spectrum" function:

See also ~ulab.extras.spectrum, which computes the magnitude of the fft, rather than separately returning its real and imaginary parts.

I haven't been able to figure out whether it's supposed to exist, or its removal was intentional. 6.3 had the similarly-named spectrogram, which has since been removed.

tannewt commented 2 years ago

@v923z and @jepler

v923z commented 2 years ago

Indeed, this is a very old relic, and the reference should be replaced by scipy.signal.spectrogram. I'll take care of it.

github-actions[bot] commented 2 years ago

Heads up @v923z - the "ulab" label was applied to this issue.

tekktrik commented 2 years ago

Not sure how to PR over to what seems to be the commit CircuitPython is using, but I submitted https://github.com/v923z/micropython-ulab/pull/522 to the base repo for this.

tekktrik commented 2 years ago

Okay, the fix should be merged into master for 8.0.0!

dhalbert commented 1 year ago

Fixed.