Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-02-12 02:12:10 +01:00
Code Issues Projects Releases Wiki Activity

clarify -a option for beet modify

Browse source 
See https://github.com/beetbox/beets/discussions/4172.

I think the confusion arises because the documentation refers to the
query. That is, when `-a` is given, albums are queried, not tracks. This
is especially clear when using `beet list`, because then it truly lists
"albums instead of items". However, for other commands, the distinction
between what is queried and what is acted on should be made more clear.

This PR fixes the section for `modify`, but there are more questions:

- `remove` command: The documentation states that it acts on albums
instead of individual tracks. I guess we should also amend that? I think
the complete album including the tracks is deleted, or is that not true?

- `move` command: I think the same is true for this command. If `-a` is
  given, the queried albums including all tracks are moved.

- `update` command: The `-a` flag is not explained here.
This commit is contained in:
Dominik Schrempf 2021-12-03 22:36:48 +01:00
parent f315a13a1b
commit e39dcfc002
No known key found for this signature in database
GPG key ID: E82B4974AA8C563A
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/reference/cli.rst
View file

@ -263,11 +263,11 @@ artist="Tom Tom Club"`` will change the artist for the track "Genius of Love."
To remove fields (which is only possible for flexible attributes), follow a
field name with an exclamation point: ``field!``.
The ``-a`` switch operates on albums instead of individual tracks. Without
this flag, the command will only change *track-level* data, even if all the
tracks belong to the same album. If you want to change an *album-level* field,
such as ``year`` or ``albumartist``, you'll want to use the ``-a`` flag to
avoid a confusing situation where the data for individual tracks conflicts
The ``-a`` switch also operates on albums in addition to the individual tracks.
Without this flag, the command will only change *track-level* data, even if all
the tracks belong to the same album. If you want to change an *album-level*
field, such as ``year`` or ``albumartist``, you'll want to use the ``-a`` flag
to avoid a confusing situation where the data for individual tracks conflicts
with the data for the whole album.
Items will automatically be moved around when necessary if they're in your