beets/docs
Dominik Schrempf e39dcfc002
clarify -a option for beet modify
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.
2021-12-03 22:36:48 +01:00
..
dev Add an 'album_removed' event. 2021-11-22 20:56:50 +00:00
guides Tweak Getting Started guide 2021-09-30 15:40:18 +02:00
plugins docs: add fetchart cover_format option 2021-11-03 13:31:33 +01:00
reference clarify -a option for beet modify 2021-12-03 22:36:48 +01:00
changelog.rst Clarify changelog entry 2021-12-02 07:36:16 -05:00
conf.py Version bump: v1.6.1 2021-11-27 11:38:48 -05:00
contributing.rst add CONTRIBUTING.rst to the docs 2020-07-20 19:56:05 -07:00
faq.rst docs/faq: add a note about 'pip install -e .' 2021-10-01 08:45:46 -05:00
index.rst Document Libera.Chat as the new official IRC home 2021-05-24 17:37:19 +02:00
Makefile Add new livereload server for docs 2016-01-25 13:19:26 -08:00
modd.conf Switch to modd for live docs build 2017-12-21 11:39:08 -05:00