DOC: Small documentation and docstring corrections for ShortTimeFFT
#19555
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DietBru
requested review from
person142,
steppi,
tylerjereddy,
peterbell10,
larsoner,
ilayn,
andyfaff and
ev-br
as code owners
DietBru
force-pushed
the
ShortTimeFFT_Doc_fixes
branch
from
41581e4 to
23681ee
Compare
lucascolley
added
maintenance
lucascolley
removed request for
andyfaff,
steppi,
ev-br,
tylerjereddy,
peterbell10 and
person142
lucascolley
reviewed
Dec 26, 2023
There was a problem hiding this comment.
thanks @DietBru, the diff LGTM - can you merge main so that we can check the docs build? The artefact has expired.
* Marked function stft(), istft() and spectrogram as legacy in docstring. * In Python code example in `signal.rst`: - Removed most doctest workarounds, i.e., expressions like ``_ = ...``. - Beautified code and y-label a little bit * Use '~' to shorten displayed link, e.g. :func:`~scipy.fft.fft()` in ShortTimeFFT.fft_mode() docstring * Fixed `ShortTimeFFT.scaling` fixed link to scale_to() method * Remove typo in ShortTimeFFT.extent()
DietBru
force-pushed
the
ShortTimeFFT_Doc_fixes
branch
from
23681ee to
6aae8e9
Compare
|
Thanks for reviewing, @lucascolley. I just rebased onto the current main. The rendered changes can be found at : |
j-bowhay
reviewed
Dec 29, 2023
| >>> fig1.colorbar(im1b, ax=axx, label="Magnitude $|S_z(t, f)|$") | ||
| >>> _ = fig1.supylabel(rf"Frequency $f$ in Hertz ($\Delta f = %g\,$Hz)" % | ||
| ... SFT.delta_f) | ||
| >>> _ = fig1.supylabel(r"Frequency $f$ in Hertz ($\Delta f = %g\,$Hz)" % |
There was a problem hiding this comment.
Do we need this?
Suggested change
| >>> _ = fig1.supylabel(r"Frequency $f$ in Hertz ($\Delta f = %g\,$Hz)" % | |
| >>> fig1.supylabel(r"Frequency $f$ in Hertz ($\Delta f = %g\,$Hz)" % |
There was a problem hiding this comment.
This is needed because otherwise python dev.py -n refguide-check would produce the following error:
File "doc/source/tutorial/signal.rst", line 1490, in /home/dietrich/GitHub/scipy/tools/../doc/source/tutorial/signal.rst
Failed example:
fig1.supylabel(r"Frequency $f$ in Hertz ($\Delta f = %g\,$Hz)" %
SFT.delta_f, x=0.08, y=0.5, fontsize='medium')
Expected nothing
Got:
Text(0.08, 0.5, 'Frequency $f$ in Hertz ($\\Delta f = 4\\,$Hz)')
ERROR: refguide or doctests have errors
|
Approved by @lucascolley, the one remaining comment from @j-bowhay seems to be addressed, and LGTM so in it goes, thanks @DietBru ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
stft(),istft()andspectrogram()as legacy in docstrings. This is a helpful clarification in the function list of the API reference.signal.rsta little bitsignal.rstand_short_time_fft.py[skip actions] [skip cirrus]