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

Make archaeology date start optional #580

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

ejimsan
Copy link
Member

@ejimsan ejimsan commented Nov 15, 2024

Summary by Sourcery

Enhancements:

  • Make the 'start' field in DateRangeSchema optional by allowing None values.

Copy link
Contributor

sourcery-ai bot commented Nov 15, 2024

Reviewer's Guide by Sourcery

The PR modifies the date range schema to make the start date optional by changing the start field from required to nullable in the DateRangeSchema class.

Updated class diagram for DateRangeSchema

classDiagram
    class DateRangeSchema {
        - PartialDateSchema start
        + PartialDateSchema start
        + PartialDateSchema end
        + String notes
    }
    class PartialDateSchema
    DateRangeSchema --> PartialDateSchema
    note for DateRangeSchema "The 'start' field is now optional (nullable)."
Loading

File-Level Changes

Change Details Files
Modified date range schema to make start date optional
  • Changed start field from required=True to allow_none=True in DateRangeSchema
  • Aligned start field configuration with existing end field configuration
ebl/fragmentarium/application/date_schemas.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 @ejimsan - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please provide documentation explaining the use case for null start dates and how they should be interpreted
  • Consider if a more explicit approach (like a sentinel value or separate type) would be clearer than allowing null start dates
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

codeclimate bot commented Nov 15, 2024

Code Climate has analyzed commit e4ef8a2 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (75% is the threshold).

This pull request will bring the total coverage in the repository to 91.4% (0.0% change).

View more on Code Climate.

@ejimsan ejimsan merged commit 64645ed into master Nov 15, 2024
12 checks passed
@ejimsan ejimsan deleted the make-archaeology-start-optional branch November 15, 2024 13:37
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