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

Improve plot docstring #3147

Open
ericpre opened this issue May 8, 2023 · 2 comments
Open

Improve plot docstring #3147

ericpre opened this issue May 8, 2023 · 2 comments

Comments

@ericpre
Copy link
Member

ericpre commented May 8, 2023

As noticed in #3140, there is room for improvement in setting/passing arguments to the plot functions:

  • review navigator_kwds default value, need to remove setting mutable argument as default in the method definition
  • out-of-date docstring, kwargs of ImagePlot
  • docstring of ImagePlot.plot
@CSSFrancis
Copy link
Member

Just a note that we probably shouldn't be directly passing arguments to super. (or at least that is my understanding from the bit of reading that I have been doing)

By passing named arguments to the super.plot functions it opens us up to some weird behavior like what @thomasaarholt saw previously in #2338.

@ericpre
Copy link
Member Author

ericpre commented May 18, 2023

I didn't look into details but this is most likely related to use of mutable object as default argument: https://docs.quantifiedcode.com/python-anti-patterns/correctness/mutable_default_value_as_argument.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants