Minor docstring updates on spectral plot functions #10834
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
approved these changes
Mar 21, 2018
jklymak
reviewed
Mar 25, 2018
| @@ -1674,7 +1674,9 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none, | |||
| """ | |||
| Plot the cross correlation between *x* and *y*. | |||
|
|
|||
| The correlation with lag k is defined as sum_n x[n+k] * conj(y[n]). | |||
| The correlation with lag k is defined as | |||
| :math:`\sum_n x[n+k] \cdot y^*[n]`, where :math:`y^*` is the complex | |||
There was a problem hiding this comment.
OK, I can't run the tests anymore because of this math call. (SyntaxError: invalid escape sequence \s). What do I do to not get this to happen?
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.
PR Summary
As part of #10148: Docstring update for spectral plot functions.