Š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
Carl Suster
2e0230789f
docs: fix some markup issues and typos
2019-04-27 12:43:13 +10:00
Mike
1d32849daa
Add ability for play plugin to emit utf8 BOM
2018-06-08 23:26:48 -06:00
xarph
02aa6191c1
rename --force to --yes in play plugin
...
fix some pep8 goo
2017-04-19 10:51:44 -07:00
xarph
ffcaf33845
add -f argument to play command
2017-04-18 15:30:24 -07:00
diomekes
8d97257647
use shlex_split, clean up code and docs
2017-01-03 22:10:35 -05:00
diomekes
af99ee21aa
add documentation for play importer prompt choice
2016-12-31 00:15:36 -05:00
Adrian Sampson
13cf1bff8f
Tiny text simplifications ( #2223 )
2016-10-08 18:41:16 -04:00
nath@home
8bd6181c6a
doc-play: Fix a header level.
2016-10-08 14:47:38 +02:00
nath@home
f30c5da2ab
doc-play: Fix an error and clarity:
...
{} is not used any more to determine the location of parameters
passed with --args.
Fix two sentences for clarity/fluidity. Display the plugin's
abilities in the intro.
2016-10-08 14:37:57 +02:00
nath@laptop
72056e8e07
play: Fix typo treshold > threshold:
...
We should warn users that the corresponding config key changed accordingly.
2016-01-06 09:21:37 +01:00
nath@laptop
e9cfae9369
play: Document #1785
2016-01-01 12:17:12 +01:00
nath@home
940dc3c1a6
play: Add documentation for play-warn-tresh
...
Added documentation for the new warning_treshold config option for
beets-play
Also made the documentation for the use_folders option more
explicit.
2015-09-03 22:19:51 +02:00
nath@home
7ed742b268
play-raw: Fix a docstring and add doc
2015-09-01 23:42:43 +02:00
Adrian Sampson
759c79c426
play: Insert arguments anywhere ( #1532 )
2015-08-16 09:23:09 -07:00
Adrian Sampson
315fe78f0c
Example for play --args ( #1532 )
2015-08-14 19:57:05 -07:00
Adrian Sampson
ab7e9d4db2
Simplify #1532 : CLI only, append to end
2015-08-14 19:52:49 -07:00
Oliver Rümpelein
90bb4081fe
Implemented --args-feature
...
* as discussed in #1532 , with args-parameter, and optionally
inserted config-key
* updated changelog/docs
2015-08-02 20:44:56 +02:00
Bruno Cauet
c47221555f
Add beets.util.interactive_open() find cmd + execute
...
interactive_open() takes a target and an optional command, if it does not
receive a command then it uses open_anything().
It parses command and lexes it with shlex.split(), revieling the client
from that task.
"config -e" command uses it, and gives a better error message in case of
problem. "play" plugin uses it as well, as side-effect being that the
command is now interactive, as requested in issue #1321 .
Fix issue #1321 .
2015-02-16 12:26:17 +01:00
Fabrice Laporte
f7ecb9cbae
doc: emphasize options names by using bold font instead of fixed width
2014-11-07 22:13:25 +01:00
Adrian Sampson
930581ac99
Finish the pass over all plugin docs
2014-10-30 22:42:11 -07:00
Fabrice Laporte
2cd76b6714
docs: add plugin name in "how to configure" sentences
2014-10-28 23:23:10 +01: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
558c93f988
Changelog for #931
2014-09-04 10:45:34 -07:00
BrainDamage
87181de29f
updated documentation for play plugin adding relative_to option info
2014-09-04 19:28:36 +02:00
Lucas Duailibe
d1d166b5b5
Enable use of files with play -a ( closes #776 )
...
This commit changes the output of the play plugin to always use files instead of folders when generating a playlist when using the `-a` option. A new `use_folders` option was added to preserve the old behavior for anyone who wishes it.
2014-05-25 18:47:02 -03:00
Alessandro Ghedini
cff45bbf99
Add multi-option command example to the play plugin documentation
2014-05-15 11:07:58 +02:00
Adrian Sampson
e8f56c897b
play ( #708 ): obviate debug option
...
Just reuse beets' global verbose logging.
2014-04-19 14:54:20 -07:00
Adrian Sampson
9192b7f5cb
play plugin ( #708 ): docs clarification, etc.
2014-04-19 14:41:30 -07:00
david hamp-gonsalves
f8b6c1ea11
added default commands to use system file associations
2014-04-19 08:52:18 -03:00
david hamp-gonsalves
22f341eb97
added play plugin and docs
2014-04-18 10:33:53 -03:00
