Add Docstring to each individual function #7277
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mkcor
added
the
📄 type: Documentation
|
@mkcor can u please assist me with the faling job .... :) |
|
@lagru can you please assist me on this issue...:) |
|
Hey @Ganesh2409, this already looks much better; thank you. The CI is currently failing because the updated code in this PR doesn't pass the check of our code formatter. Please have a look at our contribution guide on how to setup the pre-commit hook so that future commits are formatted automatically. After you've done so run: pre-commit run --allwhich should format your code correctly. Then commit the fixes and push to this branch. :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated Documentation of adapt_rgb.py by adding docstring for each functions
Fixes: #7270
I have added the "image" parameter as an array and highlighted the additional arguments (*args, **kwargs) that can be passed to the underlying image filter function into Docstring
The docstring now explains that if the image is RGB-like, the apply_to_rgb function is used to apply the filter. Otherwise, the image filter is applied directly.