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.

Sign up for GitHub

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

Jump to bottom

Deprecate/Remove unused arguments from utils functions in napari/napari/utils/misc.py ? #6256

Closed
Carreau opened this issue Sep 24, 2023 · 2 comments · Fixed by #6836
Closed

Deprecate/Remove unused arguments from utils functions in napari/napari/utils/misc.py ? #6256

Carreau opened this issue Sep 24, 2023 · 2 comments · Fixed by #6836
Labels
good first issue Good for newcomers task

Comments

@Carreau
Copy link
Contributor

Carreau commented Sep 24, 2023

🧰 Task

In napari/utils/misc.py both def ensure_iterable and def is_iterable seem to have keywords arguments that are never used (color=False, and allow_none=False), leading to non-covered branches.

I suggest to deprecate passing the keyword arguments, then open an issue to remove branches.
@Carreau Carreau added good first issue Good for newcomers task labels Sep 24, 2023
@palec87 palec87 mentioned this issue Apr 13, 2024
Merged
@palec87
Copy link
Contributor

palec87 commented Apr 13, 2024

Hi @Carreau, this is my first PR to such extensive project. Please feel free to guide me to fix things further. Deep regards.

@Carreau
Copy link
Contributor Author

Carreau commented Apr 15, 2024

Sorry, I'm not too involved in the project anymore, but will try to comment on your PR.

andy-sweet pushed a commit to andy-sweet/napari that referenced this issue May 28, 2024
@palec87 @pre-commit-ci
@melonora @andy-sweet
DeprecationWarning in ensure_iterable and is_iterable, Closes napari#…
15ed573 
…6256 (napari#6836)

# References and relevant issues
Supposed to Close napari#6256. I am not sure about the stacklevel arg of the
warning.


# Description
Added DeprecationWarning if arguments passed and removed the
functionality related to them within the functions.

# Regarding checklist
I am not sure about the docs repo.

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Wouter-Michiel Vierdag <michiel.vierdag@embl.de>
Co-authored-by: Wouter-Michiel Vierdag <w-mv@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers task
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DeprecationWarning in ensure_iterable and is_iterable, Closes #6256 palec87/napari
2 participants
@Carreau @palec87