Skip to content

Documentation fixes #24861

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 4 commits into from
Mar 7, 2023
Merged

Documentation fixes #24861

merged 4 commits into from
Mar 7, 2023

Conversation

oscargus
Copy link
Member

@oscargus oscargus commented Jan 1, 2023

PR Summary

Some documentation fixes for consistency/linking. Split into four commits for ease of reviewing/sensible commit message.

(It seems like numpy.uint8 is really an alias so it may make sense to document numpy.ubyte although uint8 is more descriptive on its own. Same with all the other int/floatXX types.)

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@oscargus
Copy link
Member Author

oscargus commented Mar 7, 2023

Not sure what took me so long to get back to this... Fixed now (and in a few other locations as well).

@QuLogic QuLogic merged commit fb356ed into matplotlib:main Mar 7, 2023
@QuLogic QuLogic added this to the v3.8.0 milestone Mar 7, 2023
@oscargus oscargus deleted the docfixes branch March 8, 2023 06:05
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