Skip to content
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

DOC: annotate_* plot methods docstrings and implementation need an overhaul #4467

Open
1 of 18 tasks
neutrinoceros opened this issue Jun 3, 2023 · 0 comments
Open
1 of 18 tasks
Labels
api-consistency naming conventions, code deduplication, informative error messages, code smells... docs viz: 2D

Comments

@neutrinoceros
Copy link
Member

neutrinoceros commented Jun 3, 2023

Most of these methods support passing arbitrary keyword arguments over some matplotlib API via **kwargs. However, their docstrings often doesn't mention exactly where these arguments are passed to, which hurts discoverability, and forces users to inspect the source code we could redirect them to matplotlib's documentation instead.
There's also room left to improve API consistency by generalising the **kwargs pattern a bit further.

I have already started working on this as a side effect of improving some of the annotation methods lately. This issue will help tracking what needs to be done.

some callbacks accept 2 dicts of arbitrary arguments, one of which could be deprecated in favour of the **kwargs pattern

  • GridBoundaryCallback
  • TextLabelCallback
  • TimestampCallback
  • ScaleCallback
  • LineIntegralConvolutionCallback
  • CellEdgesCallback
  • SphereCallback

some currently re-expose a subset of args and aren't yet natively extensible using **kwargs, which should be changed:

@neutrinoceros neutrinoceros added viz: 2D docs api-consistency naming conventions, code deduplication, informative error messages, code smells... labels Jun 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-consistency naming conventions, code deduplication, informative error messages, code smells... docs viz: 2D
Projects
None yet
Development

No branches or pull requests

1 participant