Reuse USAGE string to reduce duplication

rdswift · Oct 26, 2023 · c6e72e9 · c6e72e9
1 parent ceda8a4
commit c6e72e9
Showing 1 changed file with 15 additions and 26 deletions.
diff --git a/plugins/script_logger/__init__.py b/plugins/script_logger/__init__.py
@@ -21,14 +21,9 @@
 
 PLUGIN_NAME = 'Script Logger'
 PLUGIN_AUTHOR = 'Bob Swift (rdswift)'
-PLUGIN_DESCRIPTION = '''
-This plugin provides a new script function `$logline()` to write entries
-to Picard's system log.  By default, the log level is set at `Info`, but
-any level can be used by providing the level as an optional second
-parameter to the function.
-
-The function is used as:
+PLUGIN_VERSION = '0.1'
 
+USAGE = """\
 `$logline(text[,level])`
 
 where `text` is the text to write to the log.  The entry will be written
@@ -42,29 +37,23 @@
 
 If an unknown level is entered, the function will use the default `Info`
 level.
-'''
-PLUGIN_VERSION = '0.1'
-PLUGIN_API_VERSIONS = ['2.0', '2.1', '2.2', '2.3', '2.6', '2.9']
-PLUGIN_LICENSE = "GPL-2.0"
-PLUGIN_LICENSE_URL = "https://www.gnu.org/licenses/gpl-2.0.txt"
+"""
 
-PLUGIN_USER_GUIDE_URL = "https://github.com/rdswift/picard-plugins/blob/2.0_RDS_Plugins/plugins/script_logger/docs/README.md"
+PLUGIN_DESCRIPTION = '''
+This plugin provides a new script function `$logline()` to write entries
+to Picard's system log.  By default, the log level is set at `Info`, but
+any level can be used by providing the level as an optional second
+parameter to the function.
 
-DOCUMENTATION = """\
-`$logline(text[,level])`
+The function is used as:
 
-where `text` is the text to write to the log.  The entry will be written
-at log level `Info` by default, but this can be changed by specifying a
-different level as an optional second parameter.  Allowable log levels are:
+''' + USAGE
 
-- E (Error)
-- W (Warning)
-- I (Info)
-- D (Debug)
+PLUGIN_API_VERSIONS = ['2.0', '2.1', '2.2', '2.3', '2.6', '2.9']
+PLUGIN_LICENSE = "GPL-2.0"
+PLUGIN_LICENSE_URL = "https://www.gnu.org/licenses/gpl-2.0.txt"
 
-If an unknown level is entered, the function will use the default `Info`
-level.
-"""
+PLUGIN_USER_GUIDE_URL = "https://github.com/rdswift/picard-plugins/blob/2.0_RDS_Plugins/plugins/script_logger/docs/README.md"
 
 from picard import log
 from picard.script import register_script_function
@@ -93,4 +82,4 @@ def logline(_parser, text: str, level=None):
     LEVELS[_level](text.strip())
     return ''
 
-register_script_function(logline, documentation=DOCUMENTATION)
+register_script_function(logline, documentation=USAGE)