From b303d5beb082bff851759bbe79c3ab5337e4cfa4 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Mon, 17 Jul 2017 10:59:04 -0400 Subject: [PATCH] Slightly more complete sentences in comments --- beetsplug/lyrics.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/beetsplug/lyrics.py b/beetsplug/lyrics.py index 7c81d3a81..57265a469 100644 --- a/beetsplug/lyrics.py +++ b/beetsplug/lyrics.py @@ -77,7 +77,7 @@ URL_CHARACTERS = { } USER_AGENT = 'beets/{}'.format(beets.__version__) -# the content for the base index.rst generated +# The content for the base index.rst generated in ReST mode. REST_INDEX_TEMPLATE = u'''Lyrics ====== @@ -93,7 +93,7 @@ Artist index: artists/* ''' -# the content for the base conf.py generated +# The content for the base conf.py generated. REST_CONF_TEMPLATE = u'''# -*- coding: utf-8 -*- master_doc = 'index' project = u'Lyrics' @@ -640,12 +640,13 @@ class LyricsPlugin(plugins.BeetsPlugin): self.config['google_API_key'].redact = True self.config['google_engine_ID'].redact = True self.config['genius_api_key'].redact = True - # state information for the ReST writer - # the current artist + + # State information for the ReST writer. + # First, the current artist we're writing. self.artist = u'Unknown artist' - # the current album, False means no album yet + # The current album: False means no album yet. self.album = False - # the current rest file content. None means the file is not + # The current rest file content. None means the file is not # open yet. self.rest = None