Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix table.Cell docstrings. #17029

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
Apr 4, 2020
Merged

Fix table.Cell docstrings. #17029

merged 1 commit into from
Apr 4, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Apr 4, 2020

  • Previously the "note" would be treated as a comment (it needs two
    end colons); we can just make it plain text anyways.
  • Moving the doc for the parameters to __init__ avoids __init__
    inheriting the docstring of the parent Rectangle.__init__ and thus
    the rendered docs getting two copies of the parameter list, with only
    one being correct.

See https://matplotlib.org/api/table_api.html#matplotlib.table.Cell.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

- Previously the "note" would be treated as a comment (it needs *two*
  end colons); we can just make it plain text anyways.
- Moving the doc for the parameters to `__init__` avoids `__init__`
  inheriting the docstring of the parent `Rectangle.__init__` and thus
  the rendered docs getting two copies of the parameter list, with only
  one being correct.
@anntzer anntzer added this to the v3.3.0 milestone Apr 4, 2020
Copy link
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

restarted the failing job. Anyone can merge on CI green.

@anntzer
Copy link
Contributor Author

anntzer commented Apr 4, 2020

That specific osx test has been failing for me the whole day.

@timhoffm
Copy link
Member

timhoffm commented Apr 4, 2020

The test failure is unrelated.

@timhoffm timhoffm merged commit fc8a2fa into matplotlib:master Apr 4, 2020
@anntzer anntzer deleted the celldoc branch April 4, 2020 20:34
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