Remove :func: markup from mlab docstrings. #13178
Merged
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
anntzer
commented
Jan 14, 2019
| :func:`window_hanning`. If a function is passed as the | ||
| argument, it must take a data segment as an argument and | ||
| return the windowed version of the segment. | ||
| A function or a vector of length *NFFT*. To create window vectors see |
anntzer
commented
Jan 14, 2019
| :func:`~matplotlib.mlab.detrend_mean`. 'linear' calls | ||
| :func:`~matplotlib.mlab.detrend_linear`. 'none' calls | ||
| :func:`~matplotlib.mlab.detrend_none`. | ||
| The function applied to each segment before fft-ing, designed to |
Makes the unrendered docstrings a bit more readable.
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.
Makes the unrendered docstrings a bit more readable (IMO...).
PR Summary
PR Checklist