-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Fix in PlasmaBrightnesscontrast docstring #2383
Conversation
Reviewer's Guide by SourceryThis pull request adds documentation for the Updated class diagram for PlasmaBrightnessContrastclassDiagram
class PlasmaBrightnessContrast {
-brightness_range: tuple[float, float]
-contrast_range: tuple[float, float]
-plasma_size: int
-roughness: float
+__init__(
brightness_range: tuple[float, float] = (-0.2, 0.2),
contrast_range: tuple[float, float] = (-0.3, 0.3),
plasma_size: int = 256,
roughness: float = 3.0,
always_apply: bool = False,
p: float = 0.5
)
+apply(img: np.ndarray, **params: Any) -> np.ndarray
+get_transform_init_args_names() -> tuple[str, ...]
}
note for PlasmaBrightnessContrast "Added plasma_size parameter"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @ternaus - I've reviewed your changes - here's some feedback:
Overall Comments:
- It's good to see the example in the docstring was updated to reflect the new parameter.
- Consider adding
plasma_size
toInitSchema
inPlasmaShadow
as well for consistency.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Summary by Sourcery
Documentation: