rename the skip option to local

skip was a misnomer: we actually skip "unfetched" lyrics. this means
it's somewhat of a double-negative and really confusing.

--local is clearer, although less in opposition with --force
This commit is contained in:
Antoine Beaupré 2017-07-15 14:19:25 -04:00
parent 32de4148bc
commit d330353e1c
No known key found for this signature in database
GPG key ID: 792152527B75921E
2 changed files with 7 additions and 6 deletions

View file

@ -598,7 +598,7 @@ class LyricsPlugin(plugins.BeetsPlugin):
"76V-uFL5jks5dNvcGCdarqFjDhP9c",
'fallback': None,
'force': False,
'skip': False,
'local': False,
'sources': self.SOURCES,
})
self.config['bing_client_secret'].redact = True
@ -673,9 +673,9 @@ class LyricsPlugin(plugins.BeetsPlugin):
help=u'always re-download lyrics',
)
cmd.parser.add_option(
u'-s', u'--skip', dest='skip_fetched',
u'-l', u'--local', dest='local_only',
action='store_true', default=False,
help=u'skip already fetched lyrics',
help=u'do not fetch missing lyrics',
)
def func(lib, opts, args):
@ -686,7 +686,7 @@ class LyricsPlugin(plugins.BeetsPlugin):
album = False
output = sys.stdout
for item in lib.items(ui.decargs(args)):
if not opts.skip_fetched and not self.config['skip']:
if not opts.local_only and not self.config['local']:
self.fetch_item_lyrics(
lib, item, write,
opts.force_refetch or self.config['force'],

View file

@ -133,8 +133,9 @@ Then the correct format can be generated with one of::
sphinx-build -b html . _build/html
The ``-f`` option forces the command to fetch lyrics, even for tracks that
already have lyrics. Inversely, the ``-s`` option skips lyrics that
are not locally available, to dump lyrics faster.
already have lyrics. Inversely, the ``-l`` option restricts operations
to lyrics that are locally available, to show lyrics faster without
retrying them over the network all the time.
.. _activate-google-custom-search: