Skip to content

Minor fixes to plot_directive. #9425

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
Oct 20, 2017

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Oct 16, 2017

  1. The plot_directive function was reusing the module's docstring, but
    the latter is not valid numpydoc. Replace by a short stub pointing
    to the module docstring.

Thanks to @NelleV who pointed this out in #9149.

  1. jinja2 is a requirement of sphinx since 2008 (sphinx-doc/sphinx@eeb494c),
    so we can reasonably drop the code to support jinja1.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 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

1. The `plot_directive` function was reusing the module's docstring, but
   the latter is not valid numpydoc.  Replace by a short stub pointing
   to the module docstring.

2. jinja2 is a requirement of sphinx since 2008 (sphinx-doc/sphinx@eeb494c),
   so we can reasonably drop the code to support jinja1.
@dstansby dstansby added this to the v2.2 milestone Oct 17, 2017
NelleV added a commit that referenced this pull request Oct 20, 2017
@NelleV NelleV merged commit 1880893 into matplotlib:master Oct 20, 2017
@NelleV NelleV merged commit 7827326 into matplotlib:master Oct 20, 2017
@anntzer anntzer deleted the plot_directive-docstring branch October 20, 2017 18:37
@QuLogic
Copy link
Member

QuLogic commented Oct 20, 2017

@NelleV NelleV merged commit 1880893 into matplotlib:master 3 hours ago
@NelleV NelleV merged commit 7827326 into matplotlib:master 3 hours ago
@NelleV NelleV closed this 3 hours ago

Well, GitHub certainly seems a bit confused here...

@tacaswell
Copy link
Member

The git log looks correct 🤷‍♂️ .

@QuLogic QuLogic modified the milestones: needs sorting, v2.2.0 Feb 12, 2018
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.

5 participants