Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Release notes improvement#1961

Merged
emako merged 2 commits into
QL-Win:masterfrom
Shakes4cc:release-notes-improvement
Jun 16, 2026
Merged

Release notes improvement#1961
emako merged 2 commits into
QL-Win:masterfrom
Shakes4cc:release-notes-improvement

Conversation

@Shakes4cc

@Shakes4cc Shakes4cc commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Brief Description of Changes

The "QuickLook has been updated" title on the release notes can lead the user to think that the program has been automatically updated.
Since updates must be done manually, telling the user that "A new version of QuickLook is available" is more accurate.
This PR also fixes a typo in the English string of the Update_Found notification.

Summary by Sourcery

Update release notes messaging to clarify that a new QuickLook version is available rather than implying it was auto-updated.

Bug Fixes:

  • Correct a typo in the English text of the update notification.

Enhancements:

  • Improve release notes heading text to avoid suggesting automatic updates and better reflect manual update behavior.

@sourcery-ai

sourcery-ai Bot commented Jun 15, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adjusts user-facing update messaging in release notes and translations to clarify that QuickLook updates are manual and fixes a typo in the Update_Found notification string.

Sequence diagram for updated release notes messaging

sequenceDiagram
    actor User
    participant Updater
    participant GitHubAPI
    participant ReleaseNotesUI

    User->>Updater: CollectAndShowReleaseNotes()
    Updater->>GitHubAPI: DownloadJson(releases_url)
    GitHubAPI-->>Updater: releases_json
    Updater->>Updater: set notes to "# A new version of QuickLook is available!"
    Updater->>ReleaseNotesUI: Show(notes, releases_json)
    ReleaseNotesUI-->>User: Display updated release notes message
Loading

File-Level Changes

Change Details Files
Clarify release notes header to indicate a new version is available rather than implying an automatic update.
  • Update the hardcoded release-notes Markdown title from 'QuickLook has been updated!' to 'A new version of QuickLook is available!'
  • Keep the rest of the release notes collection and rendering logic unchanged
QuickLook/Helpers/Updater.cs
Correct wording/typo in the localized Update_Found notification string.
  • Adjust the English translation text for the Update_Found notification to fix a typo and align with the new update phrasing
  • Leave other translation keys and languages untouched
QuickLook/Translations.config

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Since the release notes heading text and the update notification string now convey similar information, consider centralizing these user-facing messages (e.g., in a shared resource or constant) to avoid divergence in future wording updates.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Since the release notes heading text and the update notification string now convey similar information, consider centralizing these user-facing messages (e.g., in a shared resource or constant) to avoid divergence in future wording updates.

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.

@emako emako merged commit ed2a36b into QL-Win:master Jun 16, 2026
3 checks passed
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