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

Docstring of color.hsv_value is incomplete #7270

Open
lagru opened this issue Dec 17, 2023 · 3 comments · May be fixed by #7277
Open

Docstring of color.hsv_value is incomplete #7270

lagru opened this issue Dec 17, 2023 · 3 comments · May be fixed by #7277
Labels
🔰 Good first issue 📄 type: Documentation Updates, fixes and additions to documentation

Comments

@lagru
Copy link
Member

lagru commented Dec 17, 2023

Description

color.hsv_value is incomplete:

scikit-image/skimage/color/adapt_rgb.py

Lines 48 to 59 in 09577ed

def hsv_value(image_filter, image, *args, **kwargs):
"""Return color image by applying `image_filter` on HSV-value of `image`.
Note that this function is intended for use with `adapt_rgb`.
Parameters
----------
image_filter : function
Function that filters a gray-scale image.
image : array
Input image. Note that RGBA images are treated as RGB.
"""

args and kwargs should be documented as well as the return value. It could also be made clearer that image expects an RGB(A) image.
@lagru lagru added 🔰 Good first issue 📄 type: Documentation Updates, fixes and additions to documentation labels Dec 17, 2023
@lagru
Copy link
Member Author

lagru commented Dec 17, 2023

Additionally, this function isn't part of skimage.colors API even though the gallery example plot_adapt_rgb hints that is should be.

This was referenced Dec 22, 2023
Closed
Closed
@davidemusi
Copy link

Hi @lagru
Please can I take on this if it was not resolved.

@lagru lagru linked a pull request Dec 29, 2023 that will close this issue
Open
@lagru
Copy link
Member Author

lagru commented Dec 29, 2023

Hey @davidemusi, thanks for asking and offering your help. However, this is already worked on in #7277. If you would like, you could try to help that one along. :)

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 📄 type: Documentation Updates, fixes and additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Docstring to each individual function Ganesh2409/scikit-image
2 participants
@lagru @davidemusi