Fix rotate.py:Rotate.border_mode docstring to tell the correct default.

[MalteEbner]

Description

In #2245, the border_mode was changed to cv2.BORDER_CONSTANT. However, the docstring was not updated. This PR fixes it by updating the docstring as well.

Tests

Not tested at all, as it only updates the docstring

Summary by Sourcery

Documentation:

• Clarify the default border mode used in the Rotate transform.

[sourcery-ai]

Reviewer's Guide by Sourcery

The pull request updates the docstring for the border_mode parameter in the Rotate class to reflect the correct default value, which is cv2.BORDER_CONSTANT.

Class diagram showing the Rotate class docstring update

classDiagram
    class Rotate {
        +rotate(image, angle, interpolation, border_mode, fill, fill_mask, rotate_method)
    }
    note for Rotate "border_mode default changed to cv2.BORDER_CONSTANT"

Loading

File-Level Changes

Change	Details	Files
Updated the docstring for the border_mode parameter in the Rotate class.	Corrected the default value of border_mode in the docstring to cv2.BORDER_CONSTANT.	albumentations/augmentations/geometric/rotate.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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @MalteEbner - 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[ternaus]

Thanks. Trying my best to generate docstrings based on the code, but it the sitiation is far from perfect.

Thanks again.