Skip to content

Fix/add docstring signatures to many C++ methods. #21746

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
Nov 25, 2021

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Nov 25, 2021

In particular, all methods were missing the self arg in the documented
signature (one can check that this matters e.g. by inspecting
inspect.signature(matplotlib.ft2font.FT2Image.draw_rect)).

(xref #15009)

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

In particular, all methods were missing the self arg in the documented
signature (one can check that this matters e.g. by inspecting
`inspect.signature(matplotlib.ft2font.FT2Image.draw_rect)`).
@timhoffm timhoffm added this to the v3.6.0 milestone Nov 25, 2021
@timhoffm timhoffm merged commit ad4633f into matplotlib:main Nov 25, 2021
@anntzer anntzer deleted the cdoc branch November 25, 2021 18:26
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