8000 Update acorr and xcorr docs to match numpy docs by ColCarroll · Pull Request #12004 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Update acorr and xcorr docs to match numpy docs #12004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 2, 2018
Merged

Update acorr and xcorr docs to match numpy docs #12004

merged 1 commit into from
Sep 2, 2018

Conversation

ColCarroll
Copy link
Contributor

PR Summary

This updates the ax.acorr and ax.xcorr documentation and code to reflect the numpy documentation. Specifically, the code currently calls np.correlate with mode=2, while the documentation in numpy for mode reads:

mode : {'valid', 'same', 'full'}, optional
    Refer to the `convolve` docstring.  Note that the default
    is 'valid', unlike `convolve`, which uses 'full'.

It turns out mode=2 eventually maps to mode="full", and this change makes that explicit.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

jklymak
jklymak approved these changes Sep 2, 2018
View reviewed changes
Copy link
Member
@jklymak jklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@jklymak jklymak added this to the v3.1 milestone Sep 2, 2018
@jklymak jklymak merged commit 3fdf3c0 into matplotlib:master Sep 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jklymak jklymak jklymak approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.1.0
Development

Successfully merging this pull request may close these issues.
2 participants
@ColCarroll @jklymak
0