Skip to content

Conversation

@arsaboo
Copy link
Contributor

@arsaboo arsaboo commented Sep 17, 2025

Missing plugin documentation was not right. The format option does not work. Updated it to reflect the use of global album and item format.

Copilot AI review requested due to automatic review settings September 17, 2025 17:27
@arsaboo arsaboo requested a review from a team as a code owner September 17, 2025 17:27
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Sep 17, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updated the Missing plugin documentation to replace the unsupported format option with separate album_format and item_format settings, and clarified available formatting tokens and usage examples to reflect global format behavior.

File-Level Changes

Change Details Files
Replace deprecated format option with album_format and item_format
  • Removed all references to the old format config key
  • Introduced album_format for album-level naming
  • Introduced item_format for item-level naming
  • Updated example configuration block to use the new options
docs/plugins/missing.rst
Clarify formatting details and token usage
  • Added description of global format inheritance
  • Expanded list of supported tokens and their meanings
  • Adjusted narrative to reflect how album and item formats interact
docs/plugins/missing.rst

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
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Updates the missing plugin documentation to correct inaccurate configuration details and clarify formatting behavior. The format option was incorrectly documented and has been removed in favor of using global formatting options.

  • Removed incorrect format configuration option documentation
  • Added new Formatting section explaining the use of global format_item and format_album options
  • Updated example configuration to demonstrate proper global format usage

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

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 there - I've reviewed your changes and they look great!


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
Contributor

@semohr semohr left a comment

Choose a reason for hiding this comment

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

LGTM

@snejus snejus enabled auto-merge September 21, 2025 18:46
@snejus snejus merged commit 159f43c into beetbox:master Sep 21, 2025
15 checks passed
@arsaboo arsaboo deleted the missing branch September 21, 2025 19:26
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.

3 participants