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

Cleaned docstring in FancyPCA #2381

Merged
merged 1 commit into from
Mar 5, 2025
Merged

Cleaned docstring in FancyPCA #2381

merged 1 commit into from
Mar 5, 2025

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Mar 5, 2025

Summary by Sourcery

Updates the docstring for FancyPCA to remove the tuple option for the alpha parameter. Updates ruff pre-commit hook to v0.9.9 and pyproject-fmt to v2.5.1.

Enhancements:

  • Updates the docstring for FancyPCA to remove the tuple option for the alpha parameter, clarifying that only a single float value is expected for the alpha parameter.
  • Updates ruff pre-commit hook to v0.9.9.
  • Updates pyproject-fmt to v2.5.1.

Copy link
Contributor

sourcery-ai bot commented Mar 5, 2025

Reviewer's Guide by Sourcery

This pull request cleans up the docstring for the FancyPCA class and updates the pre-commit hooks to use newer versions of ruff and pyproject-fmt.

Updated class diagram for FancyPCA

classDiagram
  class FancyPCA {
    -alpha: float
    -p: float
  }
  note for FancyPCA "Updated docstring: alpha is now a float instead of a tuple[float, float] | float"
Loading

File-Level Changes

Change Details Files
Updated the docstring for the FancyPCA class to simplify the description of the alpha parameter.
  • Removed the tuple option for the alpha parameter in the docstring.
  • Clarified that a single float is used for the standard deviation of the Gaussian distribution.
albumentations/augmentations/transforms.py
Updated pre-commit hooks to use newer versions of ruff and pyproject-fmt.
  • Updated ruff pre-commit hook from v0.9.8 to v0.9.9.
  • Updated pyproject-fmt pre-commit hook from v2.5.0 to v2.5.1.
.pre-commit-config.yaml

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:

  • Consider reverting the pre-commit hook version changes, as they are unrelated to the core change.
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 eeee01e into main Mar 5, 2025
14 checks passed
@ternaus ternaus deleted the fix_fancy_pca branch March 5, 2025 03:22
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