Skip to content

Remove unnecessary .figure qualifier in docs.#22075

Merged
timhoffm merged 1 commit intomatplotlib:mainfrom
anntzer:unfig
Jan 1, 2022
Merged

Remove unnecessary .figure qualifier in docs.#22075
timhoffm merged 1 commit intomatplotlib:mainfrom
anntzer:unfig

Conversation

@anntzer
Copy link
Copy Markdown
Contributor

@anntzer anntzer commented Jan 1, 2022

figure.Figure actually looks not so nice in rendered docs and Figure
is just as clear; one can suppress the leading figure with a tilde but
it can also just be removed.

PR Summary

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • 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).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

`figure.Figure` actually looks not so nice in rendered docs and `Figure`
is just as clear; one can suppress the leading `figure` with a tilde but
it can also just be removed.
@timhoffm timhoffm added this to the v3.6.0 milestone Jan 1, 2022
@timhoffm timhoffm merged commit d1216c2 into matplotlib:main Jan 1, 2022
@anntzer anntzer deleted the unfig branch January 1, 2022 23:42
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.

3 participants