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 docstring in sharpen #2181

Merged
merged 2 commits into from
Dec 8, 2024
Merged

Fix docstring in sharpen #2181

merged 2 commits into from
Dec 8, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Dec 8, 2024

Summary by Sourcery

Documentation:

  • Correct the type annotation in the docstring for the 'method' parameter in the Sharpen class.

Copy link
Contributor

sourcery-ai bot commented Dec 8, 2024

Reviewer's Guide by Sourcery

This PR improves the docstring of the Sharpen class by making the method parameter type annotation more specific using a Literal type.

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

File-Level Changes

Change Details Files
Updated type annotation for the method parameter in the Sharpen transform
  • Changed type hint from str to Literal['kernel', 'gaussian'] to explicitly show allowed values
  • Maintained existing documentation of parameter options and default value
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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 and they look great!

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.

Copy link

codecov bot commented Dec 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.77%. Comparing base (b1a79c2) to head (434fff4).
Report is 305 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2181       +/-   ##
=========================================
+ Coverage      0   89.77%   +89.77%     
=========================================
  Files         0       47       +47     
  Lines         0     8431     +8431     
=========================================
+ Hits          0     7569     +7569     
- Misses        0      862      +862     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ternaus ternaus merged commit 47c2450 into main Dec 8, 2024
16 checks passed
@ternaus ternaus deleted the fix_docstring_in_sharpen branch December 8, 2024 03:24
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