Commit graph

52 commits

Author SHA1 Message Date
Šarūnas Nejus
498b14ee1d
Convert autotagger plugin docs to use conf role 2025-10-19 01:34:33 +01:00
Šarūnas Nejus
455d620ae0
Fix data source penalty application logic
The data_source penalty was not being calculated correctly because
`_get_distance` was being called for **all** enabled metadata plugins
which eventually meant that matches were being penalised needlessly.

This commit refactors the distance calculation to:
- Remove the plugin-based track_distance() and album_distance() methods
  that were applying penalties incorrectly
- Calculate data_source penalties directly in track_distance() and
  distance() functions when sources don't match
- Use a centralized get_penalty() function to retrieve plugin-specific
  penalty values via a registry with O(1) lookup
- Change default data_source_penalty from 0.0 to 0.5 to ensure
  mismatches are penalized by default
- Add data_source to get_most_common_tags() to determine the likely
  original source for comparison

This ensures that tracks and albums from different data sources are
properly penalized during matching, improving match quality and
preventing cross-source matches.
2025-10-10 20:36:33 +01:00
Šarūnas Nejus
01e2eb4665
Add default config yaml to each data source docs 2025-10-10 20:36:33 +01:00
Henry
f5acdec2b1 Update configuration format. 2025-10-03 14:44:22 -07:00
Henry
fcebe8123a Expand documentation 2025-09-30 20:01:35 -07:00
Henry
b1903417f4 Add artist credit support, artist name variation support, more flexible featured credit. 2025-09-27 14:29:25 -07:00
Henry
dda265dc77 Disambiguation fix implemented & tested 2025-09-19 20:46:07 -07:00
Luccoli
535fcfdbe7 docs: update discogs.rst - add default of index_tracks configuration 2025-08-25 19:14:12 +01:00
Šarūnas Nejus
ab5acaabb3
Reformat all docs using docstrfmt 2025-08-10 16:25:05 +01:00
Šarūnas Nejus
769dcdc88a
Docs: fix linting issues 2025-08-10 16:16:02 +01:00
Šarūnas Nejus
9242db04a5
discogs: add configurable search_limit 2025-05-19 09:42:06 +01:00
Šarūnas Nejus
7bbd215efc
Update all docs with Poetry 2024-06-10 13:10:16 +01:00
J0J0 Todos
1e050e2703 Add singleton matching info to Discogs plugin docs
PR #4854
2023-07-20 09:12:42 +02:00
J0J0 Todos
6abcc20df0
Merge pull request #4634 from ghbrown/discogs_s_ic
Implement item_candidates for Discogs plugin
2023-01-31 06:24:05 +01:00
ghbrown
429dfb3e7a Fix docs phrasing; fix changelog formatting 2023-01-28 18:11:22 -06:00
Stefano Pigozzi
2b600fa151
Revert the configuration section back to how it was before 2023-01-22 14:56:23 +01:00
ghbrown
47fe387de1 Docs and changelog 2023-01-21 20:56:44 -06:00
Stefano Pigozzi
54aa095882
Specify the language of a code-block 2023-01-20 13:01:23 +01:00
Stefano Pigozzi
bc379850b2
Improve formatting in the plugins/discogs page 2023-01-20 12:47:43 +01:00
ghbrown
a6dfd1b40c Writing improvements 2023-01-11 11:40:25 -06:00
ghbrown
8938319075 Add Discogs singleton limitation to docs 2023-01-10 12:25:01 -06:00
wisp3rwind
9db8d8f6a1 docs: fix broken links
these failed in the weekly CI test. discogs probably remains broken,
since it received a 403.
2022-06-12 17:41:13 +02:00
Adrian Sampson
e1d19c3a3f
Docs refinement 2022-03-03 11:17:07 +01:00
Joseph Heyburn
4bde4d082d discogs: allow style to be appended to genre
- Added more verbose documentation to `append_style_genre`
- Refactor based on code review
2022-03-03 10:03:31 +00:00
Joseph Heyburn
55e4917df3 discogs: allow style to be appended to genre
- Adds a configuration that, when enabled, will append the style to genre
- Rationale is to have more verbose genres in genre tag of players that only support genre
2022-03-02 22:04:36 +00:00
J0J0 T
2a53b890be Add to discogs plugin docs regarding PR #4227
- Clarify basic search behaviour in intro chapter of discogs plugin,
- and state change introduced in PR#4227 (discogs: Discogs query on
  insufficiently tagged files)
2022-01-10 09:10:21 +01:00
George Rawlinson
00252ab28f
Fix #3608: Replace discogs-client with python3-discogs-client
discogs-client has been deprecated since June 2020, the replacement
is actively developed by the community and does not have any breaking
API changes.

Signed-off-by: George Rawlinson <george@rawlinson.net.nz>
2021-02-27 10:09:23 +13:00
Cole Miller
5f74edf2d9 One more documentation typo 2019-12-17 17:01:34 -05:00
Cole Miller
67e402bbae Fix typo in new documentation 2019-12-17 16:57:24 -05:00
Cole Miller
90fb79f408 Document `index_tracks' option 2019-12-17 16:54:56 -05:00
Alexander Miller
279dd314ae docs/plugins: Centralize documentation of source_weight option 2019-10-01 21:19:35 +02:00
Alexander Miller
5f51b7b38e docs/plugins/discogs.rst: Update plugin documentation
Add Configuration section and describe the 'source_weight' option.
2019-10-01 07:42:31 +02:00
FichteFoll
aa31fea037
Update a lot of URLs to use HTTPS
*All* URLs were checked manually, but only once per domain!

I mostly concerned myself with URLs in documentation rather than source
code because the latter may or may not have impactful changes, while the
former should be straight forward.

Changes in addition to simply adding an s:

- changed pip and pypi references as their location has changed
- MPoD (iOS app) url redirects to Regelian, so I replaced those
- updated homebrew references

Notable observations:

- beets.io does have HTTPS set up properly (via gh-pages)
- beatport.py uses the old HTTP url for beatport
- as does lyrics.py for lyrics.wikia.com
- https://tomahawk-player.org/ expired long ago, but the http page
  redirects to https regardless
- none of the sourceforge subdomains have https (in 2019!)
2019-06-05 03:11:49 +02:00
Adrian Sampson
a29b29f533 Docs improvements for #2447 2017-02-21 09:49:22 -05:00
Robin H. Johnson
3e4c9b8c06
discogs: support simple auth.
The official OAuth authentication seems to have broken, so allow usage
of simple configuration instead.

See-Also: https://github.com/discogs/discogs_client/issues/78
Signed-off-by: Robin H. Johnson <robbat2@gentoo.org>
2017-02-20 20:20:20 -08:00
Adrian Sampson
c7045daf90 sampsyo -> beetbox (#1730) 🎉 2016-01-08 20:36:16 -08:00
Manfred Urban
95b80b37aa Updated documentation 2015-11-08 17:04:36 +01:00
Adrian Sampson
1f6a26d2b4 Spruce up the docs for #1692 2015-11-06 13:04:06 -08:00
kooimens
b11533b98f Update discogs docs 2015-11-06 19:45:05 +01:00
Adrian Sampson
e14b1d7626 Some docs massaging for imminent release 2015-04-17 14:55:16 -07:00
Bruno Cauet
4e7c8d14a8 Discogs: add troubleshooting section in docs
Mention the token file, system date. Provide a URL that searches github
issues for "discogs".

Relates to #1417.
2015-04-17 17:32:42 +02:00
Adrian Sampson
fe655e4610 discogs: Only authenticate on import (#1123)
No need to authenticate for other commands.
2014-11-30 11:18:32 -08:00
Adrian Sampson
0773d47180 Merge pull request #1047 from sampsyo/docs_overhaul
Docs overhaul
2014-10-31 14:27:43 -07:00
Fabrice Laporte
2cd76b6714 docs: add plugin name in "how to configure" sentences 2014-10-28 23:23:10 +01:00
Adrian Sampson
a3a6c01731 Docs for #1040 (fix #1027) 2014-10-26 15:50:23 -07:00
Fabrice Laporte
cb350de2ea harmonize all plugins docs
Add a configuration section that lists all options for each plugin.
List options in alphabetic order.
Mention the default value for each option.
Use same sentences to describe concepts common to different plugins eg 'auto
option, install description
2014-10-26 22:29:10 +01:00
Adrian Sampson
46340af6b7 #291: changelog and docs 2013-05-29 15:39:10 -07:00
Tai Lee
e66a865f17 Rename the discogs max rec setting to non_mb_source, so it can apply to all data source plugins. 2013-05-25 22:44:41 +10:00
Tai Lee
15be24998a Add ability to specify a maximum recommendation for Discogs matches. 2013-05-24 14:43:37 +10:00
Adrian Sampson
06887a8cef discogs: expand docs ever so slightly 2013-05-21 18:03:03 -07:00