10000 Small doc fixes. by anntzer · Pull Request #21189 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

Small doc fixes. #21189

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.

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

Merged
merged 1 commit into from
Sep 27, 2021
Merged

Small doc fixes. #21189

merged 1 commit into from
Sep 27, 2021

Conversation

anntzer
Copy link
Contributor
@anntzer anntzer commented Sep 27, 2021
  • mlab doesn't just do spectral computations, it also has GaussianKDE.
  • The "caption" example in the plot_directive doc has a quote which gets
    incorrectly highlighted as a Python string in the rendered docs; the
    technically correct solution would be to wrap the whole thing in a .. code-block:: rst but just removing the quote works just as well and
    avoids mangling the unrendered version.

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

- mlab doesn't just do spectral computations, it also has GaussianKDE.
- The "caption" example in the plot_directive doc has a quote which gets
  incorrectly highlighted as a Python string in the rendered docs; the
  technically correct solution would be to wrap the whole thing in a `..
  code-block:: rst` but just removing the quote works just as well and
  avoids mangling the unrendered version.
@dstansby dstansby added this to the v3.5.0 milestone Sep 27, 2021
@dstansby dstansby merged commit 5f44c48 into matplotlib:master Sep 27, 2021
@anntzer anntzer deleted the df branch September 27, 2021 13:30
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 27, 2021
dstansby added a commit that referenced this pull request Sep 27, 2021
…189-on-v3.5.x

Backport PR #21189 on branch v3.5.x (Small doc fixes.)
tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull request Oct 12, 2021
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0