Skip to content

Conversation

@henry-oberholtzer
Copy link
Member

Description

Fixes #6020

Add several lines to documentation to clear up possible confusion on musicbrainz plugin being disabled when plugin list is modified.

To Do

I'm not too familiar with the general roadmap or ideology behind beets yet, but there might be a later benefit to later looking into making the config.yaml generate with the musicbrainz plugin filled out by default, instead of it silently being enabled or disabled.

Another option could be to throw a warning if the Auto-Tagger doesn't detect a valid database source to query from.

Thanks for making getting my toes into contributing to open source feel easy - and let me know if there are any further changes or fixes I can apply.

  • Documentation. (If you've added a new command-line flag, for example, find the appropriate page under docs/ to describe it.)
  • Changelog. (Add an entry to docs/changelog.rst to the bottom of one of the lists near the top of the document.)
  • Tests. (Very much encouraged but not strictly required.)

@henry-oberholtzer henry-oberholtzer requested a review from a team as a code owner September 17, 2025 17:23
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Sep 17, 2025

🧙 Sourcery has finished reviewing your pull request!


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

@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!

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `docs/guides/tagger.rst:292` </location>
<code_context>

 .. _the musicbrainz database: https://musicbrainz.org/

+If you recieve a "No matching release found" message from the Auto-Tagger for an album you know is present in MusicBrainz, check that musicbrainz is in the plugin list. Until version `v2.4.0`_ the default metadate source for the Auto-Tagger, the :doc:`musicbrainz plugin </plugins/musicbrainz>`, had to be manually disabled. At present, if the plugin list is changed, musicbrainz needs to be added to the plugin list in order to continue contributing results to Auto-Tagger. 
+
 If you think beets is ignoring an album that's listed in MusicBrainz, please
</code_context>

<issue_to_address>
**issue (typo):** Correct 'recieve' to 'receive' and 'metadate' to 'metadata'.

Please update the spelling of 'recieve' to 'receive' and 'metadate' to 'metadata' in the documentation.

```suggestion
If you receive a "No matching release found" message from the Auto-Tagger for an album you know is present in MusicBrainz, check that musicbrainz is in the plugin list. Until version `v2.4.0`_ the default metadata source for the Auto-Tagger, the :doc:`musicbrainz plugin </plugins/musicbrainz>`, had to be manually disabled. At present, if the plugin list is changed, musicbrainz needs to be added to the plugin list in order to continue contributing results to Auto-Tagger. 
```
</issue_to_address>

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.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@semohr
Copy link
Contributor

semohr commented Sep 17, 2025

Heya! Thanks for the PR.

I agree we might need a bit more documentation on that.

I'm not too familiar with the general roadmap or ideology behind beets yet, but there might be a later benefit to later looking into making the config.yaml generate with the musicbrainz plugin filled out by default, instead of it silently being enabled or disabled.

By default the config is created with musicbrainz as enabled plugin. Additionally if you have the musicbrainz key in you config the plugin should be automatically loaded. I just checked and indeed we do not have a warning here. If you are up for it feel free to add one!

@henry-oberholtzer
Copy link
Member Author

Thanks for pointing that out Sebastian - I'll see if I can get a warning set up on that check, and lint the docs on this PR.

@semohr
Copy link
Contributor

semohr commented Sep 17, 2025

Glad to have you onboard! You should be able run the doc formatter with poe format-docs

@henry-oberholtzer
Copy link
Member Author

Few more commits than I'd have liked, but hey at least I'm familiar with beet's linting flow! I'll look into that lack of warning for no enabled metadata tagger, but solving that is probably better left to a different bug / PR.

@semohr
Copy link
Contributor

semohr commented Sep 17, 2025

Few more commits than I'd have liked, but hey at least I'm familiar with beet's linting flow! I'll look into that lack of warning for no enabled metadata tagger, but solving that is probably better left to a different bug / PR.

I feel you takes a bit to get used to but makes maintenance alot easier for us in the long run 😄

@semohr semohr merged commit 3336b68 into beetbox:master Sep 18, 2025
17 checks passed
@semohr
Copy link
Contributor

semohr commented Sep 18, 2025

Thank you for submitting the fix yourself and taking the time to learn our system.
We’d be happy to have you contribute more in the future!

@henry-oberholtzer henry-oberholtzer deleted the musicbrainz_documentation_update branch September 19, 2025 02:29
peterjdolan pushed a commit to peterjdolan/beets that referenced this pull request Sep 25, 2025
Add several lines to documentation to clear up possible confusion on
musicbrainz plugin being disabled when plugin list is modified.

closes beetbox#6020
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.

Update docs to reflect changes to Musicbrainz Plugin

2 participants