Commit graph

346 commits

Author SHA1 Message Date
Adrian Sampson
0fd27e1c54 Fix tiny typo in #2755 2017-12-16 15:00:50 -05:00
tummychow
e848adab04 Implement from_scratch option
Fixes #934, and also helps with #1173.
2017-12-07 14:46:40 -05:00
Meet Udeshi
1646da4d9c Add comments and explain merge feature in config docs and guide 2017-11-04 03:08:53 +05:30
Adrian Sampson
b1b4272501 Refinements to the relative date docs 2017-06-16 11:11:12 -04:00
Adrian Sampson
690ed731d8 Move the relative date docs downward
It's important to introduce the .. syntax before we get here.
2017-06-16 11:07:24 -04:00
euri10
93f064f505 Renamed relative to relative_units
Changed the return in case of a relative date, by default precision is
to the second, aka 5
Removed old 'relative' precision that indeed isn't necessary anymore
Corrected doc according to current relative date format, no more @
2017-06-16 09:14:40 +02:00
euri10
6664b656f4 Merge branch 'relativedate'
Solved conflicts with upstream of new parse classmethod of DateQuery

# Conflicts:
#	beets/dbcore/query.py
2017-06-15 08:59:43 +02:00
Adrian Sampson
71d6dc3544 Docs refinements for #2581 2017-06-13 09:27:42 -04:00
A.L. Kleijngeld
2eb4e3d515 Merge branch 'master' into master 2017-06-13 14:43:10 +02:00
Bart Kleijngeld
52d5d2310b refactoring according to feedback in pull request 2017-06-12 16:46:09 +02:00
Adrian Sampson
dfde9ce916 Merge pull request #2510 from SpirosChadoulos/master
New export command (issue #435)
2017-06-11 12:21:06 -04:00
Adrian Sampson
0a731484e2 Slight refinements to time query docs 2017-06-10 21:00:49 -04:00
discopatrick
95eeec937c Add docs for datetime queries 2017-06-01 13:11:40 +01:00
Bart Kleijngeld
91722aea36 added documentation 2017-05-30 21:29:49 +02:00
SpirosChadoulos
3c852d3539 docs 2017-05-13 12:26:31 +03:00
Adrian Sampson
8a99eea146 Merge pull request #2509 from mattmurch/Issue549
Add default replace for - to _
2017-04-16 08:56:22 -04:00
Adrian Sampson
346ecbc6d4 Slightly more verbose config overlay description 2017-04-15 15:43:26 -04:00
Adrian Sampson
8e58a61eb4 Remove one blank line 2017-04-15 15:34:09 -04:00
MolarAmbiguity
a526eb7222 Implement feedback from sampsyo 2017-04-15 09:23:35 +10:00
MolarAmbiguity
94b75e8fb4 Fix bulleted list 2017-04-14 12:57:42 +10:00
MolarAmbiguity
ad87d2af92 Add info about overlaying configs 2017-04-14 12:40:32 +10:00
Matt Murch
e224621e83 Add default replace for - to _
Also updated changelog and docs.

Resolves: #549
2017-04-12 13:48:37 -04:00
Adrian Sampson
70ef6e7df8 Fix heading underline length 2017-03-27 23:23:23 -04:00
SpirosChadoulos
218968235e small changes for the bell issue 2017-03-28 01:09:14 +03:00
SpirosChadoulos
c605a918c8 Added an if statement that allows the bell ring according to the user's configuration. 2017-03-27 20:49:28 +03:00
Adrian Sampson
af335868a8 Writing refinement for #2480
A slightly more nuanced description. Also use two separate paragraphs.
2017-03-18 14:10:21 -04:00
abigaildelarosa
bbd0b22005 change modify paragraph 2017-03-17 16:38:59 +01:00
Adrian Sampson
d22a257008 Main guide: clarify meaning of plain keyword query
Fixes #2463.
2017-03-01 20:22:30 -05:00
Adrian Sampson
d10bfa1af6 Changelog & thanks for #2445 2017-02-20 22:11:34 -05:00
Jacob Gillespie
4e77ef4484 Address review comments 2017-02-19 20:48:34 -06:00
Jacob Gillespie
1fd22604fb Fix linter issues 2017-02-19 17:33:26 -06:00
Jacob Gillespie
b4efecb709 Add option to hardlink when importing 2017-02-19 15:56:13 -06:00
karpinski
88d26e7694 Adding a move option to the importer's CLI and updating the docs. 2017-02-07 21:19:45 +01:00
euri10
d2cd4c0f21 Change relative date's format to further simplify it
A relative date doesn't need to be prefixed by @ anymore.
The relative date pattern now displays named groups.
Digits have been change to [0-9] to avoid other digit characters.
Removed the @ character in tests.
Updated subsequent documentation.
2017-01-31 16:56:03 +01:00
euri10
f0aca5e0d3 Explain relative dates
The previous version wasn't user-friendly enough and too technical.
2017-01-30 09:06:26 +01:00
euri10
c9177f2b56 removed unrelated PR changes
corrected docs with correct example
added relative date usage to it
2017-01-29 14:38:25 +01:00
euri10
e4a7d37a6d implementing changes asked
corrected rst
fixed flake8 in test
2017-01-29 11:49:22 +01:00
euri10
8d054f3656 tests flake8 issues
added some doc
2017-01-28 21:40:26 +01:00
A.L. Kleijngeld
24027d1bf8 Update config.rst: see issue #2410
`When a match is above the *medium* recommendation threshold`
->
`When a match is below the *medium* recommendation threshold`

As discussed in issue #2410, which is fixed by this edit.
2017-01-27 21:48:46 +01:00
diomekes
04f7915d41 change no-bracket argument from white space to empty 2017-01-20 22:47:47 -05:00
diomekes
3a967df396 simplify check for empty disam_val, update changelog and docs, add change bracket test 2017-01-19 20:41:44 -05:00
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
Rui Gonçalves
93c8f834f0 Add support for pregap tracks 2015-06-03 00:54:25 +01:00
Adrian Sampson
7f5c274c46 Grouped-album tasks have paths
Close #1475, fix #825.
2015-05-25 12:57:23 -07:00
Adrian Sampson
061f0f71bf Merge pull request #1466 from tomjaspers/move-pretend-option
Implement `--pretend` option for the move command
2015-05-20 21:41:15 -07:00
Scott Thomas
07e352143e File modification note in docs
I couldn't get beet update to read metadata changes - turns out that puddletag
doesn't touch the file modification time by default. It's a perfectly sensible
behaviour but I thought I'd add a note in the `beet update` section in case
anyone else has this problem.
2015-05-21 00:45:20 +01:00
Tom Jaspers
be484f2af0 Implement --pretend option for the move command
The method `show_path_changes` takes a list of tuples (source, destination)
that will be printed on either single / double line, as proposed in #1405.
2015-05-20 13:03:18 +02:00
Tom Jaspers
0302c44909 Docs & changelog for case insensitive sort 2015-04-18 10:27:56 +02:00
Adrian Sampson
6004da7c42 Expand changelog for "or" queries (#1423) 2015-04-16 19:34:20 -07:00
Adrian Sampson
bc698c3c0e Merge pull request #1423 from tomjaspers/or-query-operator
Use comma as "or" operator for queries
2015-04-16 19:25:24 -07:00
Tom Jaspers
c98835709f Query documentation to include "or" operator 2015-04-16 09:44:49 +02:00