Commit graph

426 commits

Author SHA1 Message Date
Sebastian Mohr
676dc9c953
Replaced writing-plugins with basic-plugin-setup. 2025-09-04 12:49:44 +01:00
Ryan Waskiewicz
6408b5e280
Add 'pretend' flag to update command example
Add `p` as an acceptable flag for the `update` command to match the long form section of the command's docs
2025-08-24 09:04:21 -04: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
874fb3da7b
Add changelog note about musicbrainz 2025-05-17 03:32:00 +01:00
Šarūnas Nejus
df56bfeec9
Move musicbrainz docs to a separate file 2025-05-17 03:31:59 +01:00
jwynn6
677204238c
Update pathformat.rst (#5754)
Added explainer about escaping closing braces `$}`
2025-05-11 00:55:55 +00:00
Arav K.
0a985fdfb4 [doc/reference/config] Re-write explanation for 'overwrite_null'
See: <https://github.com/beetbox/beets/pull/5373#discussion_r1702848037>
2024-09-12 14:26:50 +02:00
Arav K.
c668dfae71 Document 'overwrite_null'
Solves #5314.
2024-09-12 14:26:50 +02:00
Šarūnas Nejus
54b2435c72
Update dependencies and do not install reflink on Windows for tests (#5407)
See my comment under #5406 for context

> The build on win32 is failing to install reflink because it's [only
supported until Python
3.7](https://gitlab.com/rubdos/pyreflink/-/blob/master/setup.py?ref_type=heads).
>
> I will address this in a separate PR and rebase this one accordingly
once the fix is merged.
>
> Note: this issue popped up now because I added a new requests-mock
dependency which invalidated cached dependencies.
2024-09-08 12:31:02 +01:00
Tânio Scherer
0b067e9f5b Create a new template function: capitalize
Update documentation

Update changelog
2024-09-05 23:00:50 -03:00
Šarūnas Nejus
c2d9bcf767
Update dead link in reflink docs 2024-09-04 19:06:55 +01:00
Šarūnas Nejus
981a61bd56
Add support for filtering relations 2024-06-21 15:05:29 +01:00
Šarūnas Nejus
2800a323a2
Revert "Make queries fast, filter all flexible attributes (#5240)"
This reverts commit 143b9202f3, reversing
changes made to 8508a57d77.
2024-06-19 21:51:44 +01:00
Šarūnas Nejus
2f80ff07e4
Add a changelog note and a mention in queries.rst 2024-06-16 23:44:07 +01:00
ktetzlaff
b47635dc29 Prefer VISUAL environment variable over EDITOR
When unix tools make use of an external editor, they typically check the
environment variable VISUAL and fall back to EDITOR. This commit adds the
additional check for VISUAL to the existing EDITOR check (where VISUAL is
preferred over EDITOR).
2024-04-14 12:15:30 +02:00
Max Goltzsche
177f284d40
expose incremental_skip_later as cli option
Closes #4958
2023-12-05 01:03:22 +01:00
Max Goltzsche
8a3b9acdee
expose import.quiet_fallback as cli option 2023-12-04 22:56:25 +01:00
Serene-Arc
fc5a9030e6 Add more detail to option 2023-11-24 13:55:27 +10:00
J0J0 Todos
dfcf256d1e Add anchor at "UI options" in docs
to make linking to it possible.
2023-10-14 10:43:12 +02:00
J0J0 Todos
18dc6dbc73 Fix ref-links in ui:length_diff_thresh docs 2023-10-14 10:43:12 +02:00
J0J0 Todos
5898736c0a Provide a working example in ui:import docs
Instead of just stating config_default.yaml's values, provide a copy/paste-able
example that changes _all_ the values and still kind of works (visually).
2023-10-14 10:43:12 +02:00
J0J0 Todos
81c10a6f5e Improve ui:import description in docs 2023-10-14 10:43:12 +02:00
Serene-Arc
d875fee722 Add text for docs section 2023-10-14 10:43:12 +02:00
J0J0 Todos
d1166c8efc Add length_diff_thresh description and ref-links
to config reference docs.
2023-10-14 10:43:12 +02:00
J0J0 Todos
5d500223b3 Draft docs update for UI code-overhaul 2023-10-14 10:43:12 +02:00
Adrian Sampson
cd0f2b1aa3
Merge pull request #4899 from fracai/update-field-exclusions
Support excluding fields with update command
2023-09-12 11:18:29 -04:00
Arno Hautala
aff9f6e313 documentation 2023-09-09 10:31:33 -04:00
Jesse Bannon
f72261e44f
Add support for artists and albumartists multi-valued tags (#4743)
Adds the following fields with id3v2.4 multi-valued tag support to autotag:
    - artists, artists_sort, artists_credit
    - albumartists, albumartists_sort, albumartists_credit
    - mb_artistids, mb_albumartistids

MusicBrainz support to populate + write the above multi-valued tags by default. Can be toggled to use id3v2.3 or id3v2.4 tags via the existing beets configuration option `id3v23`.

Big thanks to @JOJ0, @OxygenCobalt, @arsaboo for testing + @sampsyo for the initial code review .
2023-09-09 09:46:26 +02:00
J0J0 Todos
62859f4389
Merge pull request #4823 from JOJ0/album_flex_streamline
Streamline album attributes modification behaviour and allow override via CLI
2023-08-23 09:14:26 +02:00
J0J0 Todos
ef5c4de225 Add docs for duplicate_verbose_prompt option in #4866 2023-08-23 07:55:26 +02:00
J0J0 Todos
9616afd339 Fixes in docs for #4823
as suggested by @sampsyo.

Co-authored-by: Adrian Sampson <adrian@radbox.org>
2023-08-23 06:36:39 +02:00
J0J0 Todos
31cd0ecb4e Add docs for mod -a --noinherit option
and further clarify `mod -a` docs:
Even though e39dcfc002 and the linked discussion
already does a very good job on clarifying what is actually happening when `mod
-a` is issued, this commit adds further details about the difference between
the album query and what is actually modified.
2023-08-23 06:36:39 +02:00
luzpaz
8419149c7a
Fix various typos 2023-08-09 21:26:15 -04:00
J0J0 Todos
c03bd26e3a
Merge pull request #4854 from JOJ0/discogs_single_album_refactor
Support providing album information on singleton imports via Discogs
2023-07-25 06:23:27 +02:00
J0J0 Todos
a374977953 Append album to singleton disambiguation string
- New config option for the importer 'singleton_album_disambig' lets
  users choose whether they want to display [album names] in the list of
  candidates. Enabled by default but ony applicable if the candidate provides
  an album attribute.
- Add docs describing the new option and which source plugins currently support
  it.
2023-07-21 08:30:37 +02:00
J0J0 Todos
70cbe3c8ff Quickfix format in ref docs external_ids chapter 2023-07-21 06:59:36 +02:00
Alok Saboo
a5df4b95ea Update MB docs 2023-05-27 14:11:07 -04:00
J0J0 Todos
2e5394246f Docs for #4708 2023-03-25 20:51:52 +01:00
Jordyn
7f3f522973
config.rst: Remove extraneous for 2023-01-21 22:08:03 -06:00
J0J0 Todos
6b06344662 Further improve playlist plugin docs
Incorporate wording suggestions and add links to query sections.
2022-11-29 08:27:35 +01:00
Stefan Schweizer
4f51b4af2b The from_scratch option is called --from-scratch on the command line.
Fixed the documentation.
2022-11-18 16:29:26 +01:00
David Logie
cfb32d9bc5 Add a import.ignored_alias_types option to ignore alias types.
Sometimes a user may want to use an artist's locale-specific alias but
*not* want to use their legal name, for example.
2022-09-24 15:36:46 +01:00
László Koncz
27bc317fed
Fix typo 2022-08-26 12:04:47 +02:00
Adrian Sampson
1054b729d3
Merge branch 'master' into duplicate 2022-08-21 10:34:15 -07:00
Adrian Sampson
3c945cba0c
Change config key from "single" to "item"
For consistency with the rest of the terminology in the docs/config.
Also, correct the documentation (which previously only covered albums).
2022-08-21 10:31:45 -07:00
Adrian Sampson
b207224d57
Further document formatted modify with examples
I think these can make it clearer why someone would want to use this
feature. (Part of #4095.)
2022-08-20 16:47:01 -07:00
Adrian Sampson
7af40db050
Merge branch 'master' into formatted-modify 2022-08-20 16:37:52 -07:00
Adrian Sampson
f71e503f6c
Change the prefix for exact match queries
PR #4251 added exact match queries, which are great, but it was
subsequently pointed out that the `~` query prefix was already in use:
https://github.com/beetbox/beets/pull/4251#issuecomment-1069455483

So this changes the prefix from `~` to `=~`. A little longer, but
hopefully it makes the relationship to the similarly-new `=` prefix obvious.
2022-08-17 16:05:33 -07:00
Adrian Sampson
e995019edd
Doc tweaks for #4438 2022-08-17 15:55:25 -07:00