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

Sync upstream Dec 24th #4

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

HungNgien
Copy link

@HungNgien HungNgien commented Dec 24, 2024

Commit Hash Description
548f83acef4065783f6daa73e72c7e2f76921225 Use documented signal interface

Summary by Sourcery

Enhancements:

  • Replace the undocumented link key with url in the footer_link_pages signal.

Copy link

sourcery-ai bot commented Dec 24, 2024

Reviewer's Guide by Sourcery

This PR updates pretalx_pages to use the documented signal interface. Specifically, the footer_link_pages signal now uses the documented url key in its return dictionary, rather than the undocumented link key.

Sequence diagram for footer link pages signal flow

sequenceDiagram
    participant Event as Event System
    participant Signal as footer_link_pages Signal
    participant Pages as Pages Plugin
    participant URI as URI Builder

    Event->>Signal: Send signal with event and request
    Signal->>Pages: Process signal
    Pages->>URI: build_absolute_uri()
    URI-->>Pages: Return page URL
    Note over Pages: Transform to use 'url' key
    Pages-->>Signal: Return page info with url
    Signal-->>Event: Return footer links
Loading

Class diagram showing signal interface change

classDiagram
    class FooterLinkResponse {
        -title: string
        -url: string
    }
    note for FooterLinkResponse "Changed 'link' to 'url' to match documented interface"
Loading

File-Level Changes

Change Details Files
Standardize signal interface
  • Change link key to url in footer_link_pages signal's return dictionary.
pretalx_pages/signals.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

@HungNgien HungNgien marked this pull request as ready for review December 24, 2024 02:04
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 @HungNgien - 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.

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