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 make docs #2179

Merged
merged 2 commits into from
Dec 7, 2024
Merged

Fix make docs #2179

merged 2 commits into from
Dec 7, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Dec 7, 2024

Summary by Sourcery

Fix the deprecation check logic in the 'is_deprecated' function and update the README to include missing transform documentation.

Bug Fixes:

  • Fix the deprecation check in the 'is_deprecated' function to correctly identify deprecation notices in the main description of the docstring.

Documentation:

  • Add documentation entries for 'GaussNoise' and 'RandomCropNearBBox' transforms in the README.

Copy link
Contributor

sourcery-ai bot commented Dec 7, 2024

Reviewer's Guide by Sourcery

This PR improves the docstring parsing logic for deprecated transforms and updates the documentation with additional transforms. The main change is in the is_deprecated function, which now more accurately detects deprecation notices by only looking at the main description section of docstrings, not in the Args section.

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

File-Level Changes

Change Details Files
Improved deprecation detection logic in transform documentation generation
  • Removed unused warnings import
  • Enhanced is_deprecated function to only check main description section before 'Args:'
  • Added null check for docstring
  • Improved code readability with list comprehension
tools/make_transforms_docs.py
Updated transform documentation in README
  • Added GaussNoise to pixel-level transforms list
  • Added RandomCropNearBBox to spatial-level transforms table
README.md

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 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.72%. Comparing base (b1a79c2) to head (b34d296).
Report is 303 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2179       +/-   ##
=========================================
+ Coverage      0   89.72%   +89.72%     
=========================================
  Files         0       47       +47     
  Lines         0     8434     +8434     
=========================================
+ Hits          0     7567     +7567     
- Misses        0      867      +867     

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

@ternaus ternaus merged commit 8e8fb68 into main Dec 7, 2024
16 checks passed
@ternaus ternaus deleted the fix_make_docs branch December 7, 2024 20:33
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