From bb39cd509de56c2dc94beeee67c794b12e2b80c6 Mon Sep 17 00:00:00 2001 From: jmwatte Date: Sun, 15 Nov 2015 12:17:50 +0100 Subject: [PATCH] cleaned up edit.rst --- beetsplug/edit.py | 2 +- docs/plugins/edit.rst | 30 +++++++----------------------- 2 files changed, 8 insertions(+), 24 deletions(-) diff --git a/beetsplug/edit.py b/beetsplug/edit.py index 3a22d014e..8e7b0b8d3 100644 --- a/beetsplug/edit.py +++ b/beetsplug/edit.py @@ -29,7 +29,7 @@ import os def edit(filename): - """Open `filename` in a test editor. + """Open `filename` in a text editor. """ cmd = util.shlex_split(util.editor_command()) cmd.append(filename) diff --git a/docs/plugins/edit.rst b/docs/plugins/edit.rst index 45dd042e7..28ac21681 100644 --- a/docs/plugins/edit.rst +++ b/docs/plugins/edit.rst @@ -2,7 +2,7 @@ Edit Plugin ============ The ``edit`` plugin lets you open the tags, fields from a group of items, edit them in a text-editor and save them back. Add the ``edit`` plugin to your ``plugins:`` in your ``config.yaml``. Then -you simply put in a query like you normally do. +simply do a query. :: beet edit beatles @@ -11,8 +11,7 @@ you simply put in a query like you normally do. -You get a list of hits and then you can edit them. The ``edit`` opens your standard text-editor with a list of your hits and for each hit a bunch of fields. - +You get a list of hits to edit.``edit`` opens your standard text-editor with a list of your hits and for each hit a bunch of fields. Without anything specified in your ``config.yaml`` for ``edit:`` you will see for items @@ -25,24 +24,15 @@ and for albums $album-$albumartist -You can get fields from the cmdline by adding +You can get extra fields from the cmdline by adding :: - -f '$genre $added' + -e year -e comments -or - -:: - - -e '$year $comments' - -If you use ``-f '$field ...'`` you get *only* what you specified. - -If you use ``-e '$field ...'`` you get what you specified *extra*. If you add ``--all`` you get all the fields. -After you edit the values in your text-editor - *and you may only edit the values, no deleting fields or adding fields!* - you save the file, answer with ``y`` on ``Done?`` and you get a summary of your changes. Check em, answer ``y`` or ``n`` and the changes are written to your library. +After you edit the values in your text-editor - *and you may only edit the values, no deleting fields or adding fields!* - you save the file and you get a summary of your changes. Check em. Apply the changes into your library. Configuration ------------- @@ -54,12 +44,6 @@ Make a ``edit:`` section in your config.yaml ``(beet config -e)`` albumfields: genre album itemfields: track artist -* The ``albumfields:`` and ``itemfields:`` lets you list the fields you want to change. +* The ``albumfields:`` and ``itemfields:`` is a list of fields you want to change. ``albumfields:`` gets picked if you put ``-a`` in your search query, else ``itemfields:``. For a list of fields - do the ``beet fields`` command. - - -but you can pick anything else. With "<>" it will look like: -:: - - <>02<>The Night Before<>The Beatles<>Help! + do the ``beet fields`` command. Or put in a faulty one, hit enter and you get a list of available field.