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 of Downscale. #1573

Merged
merged 1 commit into from
Mar 11, 2024

Conversation

ryoryon66
Copy link
Contributor

@ryoryon66 ryoryon66 commented Mar 11, 2024

I have modified the docstring of the Downscale transform as follows.

  • Corrected the description of scale_max by changing 'lower' to 'upper' and added the upper bound constraint < 1.
  • Clarified that scale_min must be less than or equal to scale_max.

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 @ryoryon66 - I've reviewed your changes and they look great!

General suggestions:

  • Consider adding runtime checks to enforce the newly documented constraints between scale_min and scale_max to prevent misuse.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Docstrings: all looks good

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@ternaus
Copy link
Collaborator

ternaus commented Mar 11, 2024

@ryoryon66 Thank you for your work.

Would you consider becoming a sponsor of Albumentations?

https://github.com/sponsors/albumentations-team

@ternaus ternaus merged commit 597e02f into albumentations-team:main Mar 11, 2024
17 checks passed
@ryoryon66 ryoryon66 deleted the feature/fix-comment branch March 11, 2024 16:54
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.

2 participants