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

Fix in PlasmaBrightnesscontrast docstring #2382

Merged
merged 1 commit into from
Mar 5, 2025

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Mar 5, 2025

Summary by Sourcery

Documentation:

  • Adds a description for the plasma_size parameter in the PlasmaBrightnessContrast transform documentation.

Copy link
Contributor

sourcery-ai bot commented Mar 5, 2025

Reviewer's Guide by Sourcery

This pull request adds documentation for the plasma_size parameter in the PlasmaBrightnessContrast class. The plasma_size parameter controls the size of the initial plasma pattern grid. Larger values create more detailed patterns but are slower to compute. The pattern will be resized to match the input image dimensions.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added documentation for the plasma_size parameter in the PlasmaBrightnessContrast class.
  • Added a description of the plasma_size parameter to the class docstring.
  • Added plasma_size to the example in the docstring.
  • Added plasma_size to the InitSchema.
  • Added plasma_size to the transform init args names.
albumentations/augmentations/transforms.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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 to InitSchema in PlasmaShadow 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ternaus ternaus merged commit a55dc77 into main Mar 5, 2025
14 checks passed
@ternaus ternaus deleted the fix_docstring_plasma_brightness_contrast branch March 5, 2025 03:59
@ternaus ternaus restored the fix_docstring_plasma_brightness_contrast branch March 5, 2025 13:21
@ternaus ternaus deleted the fix_docstring_plasma_brightness_contrast branch March 5, 2025 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant