Skip to content

Conversation

gjbex
Copy link
Owner

@gjbex gjbex commented Apr 24, 2025

Summary by Sourcery

Enhance the test case for the Point class's is_on_line method by adding more comprehensive test scenarios

Documentation:

  • Update README.md with specific instructions for running tests on the points.py file

Tests:

  • Modify the test_is_on_line function to check additional line membership scenarios, including the midpoint and the original points themselves

@gjbex gjbex merged commit be40c06 into master Apr 24, 2025
Copy link

sourcery-ai bot commented Apr 24, 2025

Reviewer's Guide by Sourcery

This pull request modifies the test_is_on_line function in points.py to improve its reliability by deriving the point to be tested and adding more assertions. It also adds instructions to the README on how to run the pytest example for points.py.

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

File-Level Changes

Change Details Files
Modified the test_is_on_line function to use a derived point instead of a random point and added more assertions.
  • Removed the x and y arguments from the @given decorator.
  • The point p is now calculated as the midpoint between p1 and p2.
  • Added assertions to check if p1 and p2 are on the line defined by p1 and p2.
source-code/testing/Hypothesis/points.py
Added instructions to run pytest for the points.py example.
  • Added a command to run pytest specifically for the points.py file.
source-code/testing/Hypothesis/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. 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!

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

@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 @gjbex - I've reviewed your changes - here's some feedback:

Overall Comments:

  • It's good to see the README updated with specific instructions for running the example.
  • Consider generating p inside test_is_on_line using st.floats and then filtering to points on the line.
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.

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