-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
docs/plugins/discogs.rst: Update plugin documentation #3385
Conversation
Add Configuration section and describe the 'source_weight' option.
Thanks for this change! It seems like this is missing from |
I can certainly add it to the documentation of the beatport plugin as well.
But in the future more plugins might follow and we risk that documentation
of plugins drifts apart.
The only mention of this option in the docs is in the SpotifyPlugin but it
should apply to every plugin that provides a source of metadata. Is there a
central place in the docs to mention this?
Issues #3355 and #3371 extracted a lot of code into the superclass
MetadataSourcePlugin. Documentation could follow and describe
'source_weight' in only one place in the docs. What do you think?
…On Tue, Oct 1, 2019, 10:13 Jack Wilsdon ***@***.***> wrote:
Thanks for this change! It seems like this is missing from
docs/plugins/beatport.rst too - would you mind adding it in there as well?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#3385?email_source=notifications&email_token=AA47WJTQSCQAF6HW3R2NM5LQMMBC7A5CNFSM4I4ET462YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEAAMTYA#issuecomment-536922592>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AA47WJR3COQNOLNKRDCQU3LQMMBC7ANCNFSM4I4ET46Q>
.
|
Good question. It would be nice to centralize this information, especially because it's a pretty specialized thing that most people won't want to worry about—and if you do, then you'll worry about it in concert between multiple plugins, not just by configuring a single plugin at a time. I don't have a perfect idea about where that would be, however. Maybe on the main page about using plugins in general? I'd be open to suggestions. |
How about a section under Using Plugins in docs/plugins/index.rst that describes configuration options common to all plugins that provide a metadata source. Then, for each individual plugin a section about configuration that starts with a reference to first section followed by additional configurations. I think of something like this:
|
That's a great idea! Yeah, linking to the section seems very good. |
I have added the description of the source_weight option to docs/plugins/index.rst and updated the plugin documentation with references back to that description for beatport, deezer, discogs, and spotify. |
This looks lovely! Thank you!!! |
I have found that the documentation of DiscogsPlugin does not mention the 'source_weight' option. This PR adds that information:
Add Configuration section and describe the 'source_weight' option.