Commit graph

255 commits

Author SHA1 Message Date
diomekes
377a2a6964 add bracket argument to aunique 2017-01-19 20:39:12 -05:00
diomekes
5ee89666b6 fix typo in config docs 2017-01-07 09:54:54 -05:00
Adrian Sampson
f621d7f4f1 Merge pull request #1992 from jackwilsdon/add-write-bpm
Add write option to bpm plugin
2017-01-01 23:09:41 -05:00
Adrian Sampson
8cb6ff3892 Simplify the example config
I never meant for people to copy and paste this example---it's redundant and
probably wrong---but lots of people do! Removing a few weird options makes the
example clearer, I think, and will result in less-strange initial configs for
people who do copy & paste.
2017-01-01 19:18:25 -05:00
Adrian Sampson
f31e6110e6 Simplify #2280 docs
I've backed out the FAQ entry, since the main docs seem like the right place
for this.
2016-11-24 23:59:00 -05:00
Adrian Sampson
d6b15f4eaa Remove duplicated line in docs (#2280)
For consistency: we don't show the aliases here for the other commands.
2016-11-24 23:51:10 -05:00
Peter Kessen
488225d837 Added documentation and FAQ for selective modify 2016-11-24 19:41:31 +01:00
Peter Kessen
9f48338291 Corrected docs for modify command
added short form ´mod´ and added switch ´-f´
2016-11-24 19:04:42 +01:00
Dang Mai
8d07bfe693 Documentation for new flag 2016-10-20 23:33:20 -04:00
Diego Moreda
f0a14bfdd5 Fix documentation issues for %first
Fix a formatting problem related to sphinx not allowing spaces at the
beginning or end of an inline literal, and removed an extra sentence
at th end of the %first template function documentation.
2016-10-04 16:20:52 +02:00
Diego Moreda
0eb0353453 Revise documentation for commas in Parser 2016-10-04 16:17:26 +02:00
Stefano Rivera
bcb1f8036a Correct a typo
Spotted by lintian which runs spellchecks on man pages.
2016-08-29 16:29:32 -07:00
Dixon Xavier
80ca527f76 Fix typo in documentation 2016-06-19 13:20:54 +05:30
Dixon Xavier
fbcc8dbf1e Update changelog and documentation 2016-06-19 12:54:27 +05:30
Gondlar
3ea9706f4e Clarify which fields are searched by default 2016-06-16 18:53:55 +02:00
Jack Wilsdon
0d2923e4ea Add documentation for beet remove --force 2016-06-08 19:26:19 +01:00
Adrian Sampson
a440e44abd Proofread the changelog 2016-05-31 10:33:56 -07:00
Johnny Robeson
c1a168590c add lost+found directory to default ignore list 2016-05-06 20:51:37 -04:00
Jack Wilsdon
2d5c68cec9 Remove write option from bpm and use import.write 2016-05-06 17:50:27 +01:00
Jack Wilsdon
38a3726b1b Add documentation 2016-05-06 00:45:45 +01:00
Guilherme Danno
8c471581e0 Use the 'terminal_encoding' option for overriding the sys.stdin.encoding in some cases (#1964)
* Use the 'terminal_encoding' option for overriding the `sys.stdin.encoding` in some cases
* Add the documentation
2016-04-28 00:17:19 -03:00
Dave Hayes
2f1dd9451b Add notes for installing the ZSH completion script 2016-04-25 13:04:05 -05:00
Guilherme Danno
271f7c8d17 new template path functions: %first{} and %ifdef{} (#1951)
* New template functions: %first{} and %ifdef{}
* Add documentation
* Add to changelog
2016-04-23 13:59:25 -03:00
Peter Kessen
f6b81c1bdd Made changes suggested by @sampsyo 2016-02-04 18:35:01 +01:00
Peter Kessen
fac814421a Added documentation for changes by #1843 2016-02-04 17:59:59 +01:00
Sven-Hendrik Haase
a942719ffc Fix grammar 2016-02-03 20:38:29 +01:00
Adrian Sampson
d093ef9a47 A little more documentation for fields (#1818) 2016-01-28 13:52:07 -08:00
Diego Moreda
4f51302d09 Fix typo on importer search by id documentation 2016-01-22 19:48:22 +01:00
Diego Moreda
79d84c0e4f Style and doc fixes for MB_id importer argument
* Rename the importer argument and related variables to make it more
generic, as the feature should be independent of the backend used and
not restricted to MusicBrainz.
* Update documentation and docstrings accordingly.
* Add changelog entry.
2016-01-22 16:31:00 +01:00
Diego Moreda
b526227482 Cleanup and documentation for MB_id importer arg
* Style cleanup and fixes for the "--musicbrainzid" import argument.
* Allow the input of several IDs (separated by spaces) on the "enter Id"
importer prompt.
* Add basic documentation.
2016-01-21 17:08:53 +01:00
Adrian Sampson
c7045daf90 sampsyo -> beetbox (#1730) 🎉 2016-01-08 20:36:16 -08:00
François-Xavier Thomas
50789e88fe Fix 1583: Move command only shows modified files 2016-01-01 17:49:53 +01:00
Adrian Sampson
3855fa0766 Doc refinements for #1749 2015-12-12 17:33:23 -08:00
Diego Moreda
47ceb492dc Add docs note for custom-field sorting, fix typo
* Add note about ordering when sorting by custom-fields on query.rst.
* Fix typo on inline.rst.
2015-11-25 19:15:01 +01:00
Adrian Sampson
fd2cacbc25 Minor docs refinements for #1728
- Use a marginally more realistic example in the changelog.
- The -- convention is actually not the purview of shells; it's just a de
  facto standard for command-line parsers. Fortunately, argparse supports it
  out of the box.
2015-11-20 10:07:29 -08:00
Diego Moreda
51bf6a1c9f Add documentation for NotQuery, cleanup
* Add changelog and query.rst documentation entries for the usage of negated
queries.
* Cleanup NotQuery class as suggested during code review (PEP conforming
docstring, clarification on empty clause match behaviour).
2015-11-20 18:06:22 +01:00
Adrian Sampson
98f48237f5 Tiny docs tweaks for #1708 2015-11-08 13:04:26 -08:00
Manfred Urban
95b80b37aa Updated documentation 2015-11-08 17:04:36 +01:00
Adrian Sampson
80bfd186ae Use should_write for modify, update, and mbsync
This should address the surprising situation in #1697, where `import` went
fine but then `update` unexpectedly changed filenames.
2015-11-07 13:34:47 -08:00
Adrian Sampson
f4a617e641 Move color option in config example (fix #1653) 2015-10-19 13:44:52 -07:00
Adrian Sampson
d29cc7b2c0 Refine docs for #1586 2015-10-07 16:36:12 -07:00
Adrian Sampson
3b604c7ff9 Merge pull request #1586 from mried/RobustCaseSensitiveDetection
A robust way to check for a case sensitive file system
2015-10-07 15:43:38 -07:00
David Logie
bfc5a1b803 Add new `include` config option.
This new option allows users to provide a list of external config files
which will be evaluated when beets starts.

This is useful for keeping private settings (e.g. API keys) out of the
main configuration file.
2015-10-05 14:01:26 +01:00
Malte Ried
5832e8730e Changed the documentation of the PathQueries to reflect the usage of the file system cas-sensitivity. 2015-09-11 20:38:53 +02:00
Adrian Sampson
f8d9019d1b Better explanation of threaded option
It was pointed out that the old wording was too worrisome.
2015-09-06 17:14:55 -07:00
Ben Boeckel
323f79ecdb colors: support standard terminal colors
Fixes #1548.

Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
2015-08-05 22:00:25 -04:00
Ben Ockmore
1f1e0f7240 Added warning message and paragraph about replacements/max length interaction in documentation. 2015-07-07 17:46:42 +01:00
Adrian Sampson
e360438977 Note about escaping regex arguments in shell
A la #1520.
2015-06-25 21:27:28 -07:00
Adrian Sampson
419a12a2f2 Further clarify docs for #1493 2015-06-02 19:54:16 -07:00
Adrian Sampson
bc9caa5845 Update docs for #1493/#1104 2015-06-02 19:38:30 -07:00