8000 Use tables for Locator and Formatter docs by dstansby · Pull Request #20878 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Use tables for Locator and Formatter docs #20878

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
Aug 23, 2021
Merged

Use tables for Locator and Formatter docs #20878

merged 1 commit into from
Aug 23, 2021

Conversation

dstansby
Copy link
Member

PR Summary

I often find the existing list of these hard to read, partly because there is lots of whitespace:
Before
Screenshot 2021-08-23 at 12 35 39

I think changing these lists to tables is an improvement:
After
Screenshot 2021-08-23 at 12 35 10

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 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).

anntzer
anntzer reviewed Aug 23, 2021
View reviewed changes
anntzer
anntzer approved these changes Aug 23, 2021
View reviewed changes
Copy link
Contributor
@anntzer anntzer left a comment

Choose a reason for hiding this comment

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

Can self-merge upon CI success.

@jklymak jklymak added this to the v3.5.0 milestone Aug 23, 2021
@jklymak jklymak merged commit b9057ab into matplotlib:master Aug 23, 2021
@dstansby dstansby deleted the ticker-doc-tables branch August 23, 2021 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anntzer anntzer anntzer approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@dstansby @anntzer @jklymak
0