Skip to content
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

Remove extra newlines in contour(f) docs. #18724

Merged
merged 1 commit into from
Oct 13, 2020

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Oct 13, 2020

PR Summary

Followup to #18708.

PR Checklist

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • [n/a] 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 pydocstyle<4 and run flake8 --docstring-convention=all).
  • [n/a] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [n/a] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@QuLogic QuLogic added this to the v3.4.0 milestone Oct 13, 2020
@QuLogic QuLogic changed the title Remove exrta newlines in contour(f) docs. Remove extra newlines in contour(f) docs. Oct 13, 2020
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Are you sure this will render correctly. The concatenated docstring must look like:

        Call signature::

            contour([X, Y,] Z, [levels], **kwargs)

        `.contour` and `.contourf` draw ...

Without the empty line after the literal code block, ReST parsing will be messed up. One could likely remove one of the extra lines, but I was too lazy to check.

Anyway CI doc build will show if this works.

@QuLogic
Copy link
Member Author

QuLogic commented Oct 13, 2020

There's a newline between the end of the signature and """ and a newline between """ and the remaining description. This makes the required 2 lines between the signature and description.

Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Anybody can merge after checking that the docs render correctly.

@timhoffm timhoffm merged commit fc35fc8 into matplotlib:master Oct 13, 2020
@QuLogic QuLogic deleted the contour-doc-lines branch October 13, 2020 23:10
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.

None yet

2 participants