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

Improve documentation of lastgenre.prefer_specific's dependency on lastgenre.canonical? #2973

Closed
zsinskri opened this issue Jun 30, 2018 · 0 comments

Comments

Projects
None yet
2 participants
@zsinskri
Copy link
Contributor

commented Jun 30, 2018

Problem

When lastgenre.prefer_specific is enabled but lastgenre.canonical is not beet lastgenre will fail to apply any genres. This could be better documented.

Error message

It would be nice if there would be a error message when prefer_specific is enabled but canonical is not.
The current behaviour:

$ # with prefer_specific but without canonical:
$ beet lastgenre LITE Cubic
lastgenre: genre for album LITE - Cubic (None):
$ # compare: with canonical:
$ beet lastgenre LITE Cubic
lastgenre: genre for album LITE - Cubic (artist): Post-Rock

Suggested behaviour:

$ # with prefer_specific but without canonical:
$ beet lastgenre LITE Cubic
lastgenre: ERROR: `lastgenre.prefer_specific` is enabled but `lastgenre.canonical` is not. Please either disable `prefer_specific` or enable `canonical`!

Documentation

Currently the documentation only hints at this requirement. One could possibly make this clearer.

Alternatives

Alternatively the default canonicalisation tree could just be loaded. Care must be taken to only use it for sorting, not canonicalisation.

@sampsyo sampsyo added the docs label Jul 2, 2018

@sampsyo sampsyo closed this in #2974 Jul 2, 2018

sampsyo added a commit that referenced this issue Jul 2, 2018

Merge pull request #2974 from zsinskri/2973-lastgenre-prefer-specific…
…-without-canonical

lastgenre prefer specific without canonical (#2973)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.