Skip to content

docs/plugins/discogs.rst: Update plugin documentation - #3385

Merged
sampsyo merged 3 commits into
beetbox:masterfrom
allesmi:docs-plugins-discogs
Oct 1, 2019
Merged

docs/plugins/discogs.rst: Update plugin documentation#3385
sampsyo merged 3 commits into
beetbox:masterfrom
allesmi:docs-plugins-discogs

Conversation

@allesmi

@allesmi allesmi commented Oct 1, 2019

Copy link
Copy Markdown
Contributor

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.

Add Configuration section and describe the 'source_weight' option.
@jackwilsdon

Copy link
Copy Markdown
Contributor

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?

@allesmi

allesmi commented Oct 1, 2019 via email

Copy link
Copy Markdown
Contributor Author

@sampsyo

sampsyo commented Oct 1, 2019

Copy link
Copy Markdown
Member

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.

@allesmi

allesmi commented Oct 1, 2019

Copy link
Copy Markdown
Contributor Author

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:

Configuration

This plugin provides a source of metadata and shares configuration options as described in Using MetadataSourcePlugins. In addition, it provides the following configuration options:

  • Option A: Description of option A
  • Option B: Description of option B.

@sampsyo

sampsyo commented Oct 1, 2019

Copy link
Copy Markdown
Member

That's a great idea! Yeah, linking to the section seems very good.

@allesmi

allesmi commented Oct 1, 2019

Copy link
Copy Markdown
Contributor Author

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.

@sampsyo

sampsyo commented Oct 1, 2019

Copy link
Copy Markdown
Member

This looks lovely! Thank you!!!

@sampsyo
sampsyo merged commit d2c194d into beetbox:master Oct 1, 2019
@snejus snejus added the discogs discogs plugin label Apr 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

discogs discogs plugin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants