diff --git a/README.rst b/README.rst index 74cda5a..288316a 100644 --- a/README.rst +++ b/README.rst @@ -318,23 +318,23 @@ XML structure of a meta tag: All meta tags: -- arranger -- audioComUrl (new in v4) -- composer -- copyright -- creationDate -- lyricist -- movementNumber -- movementTitle -- mscVersion -- platform -- poet (not in v4) -- source -- sourceRevisionId -- subtitle -- translator -- workNumber -- workTitle +- ``arranger`` +- ``audioComUrl`` (new in v4) +- ``composer`` +- ``copyright`` +- ``creationDate`` +- ``lyricist`` +- ``movementNumber`` +- ``movementTitle`` +- ``mscVersion`` +- ``platform`` +- ``poet`` (not in v4) +- ``source`` +- ``sourceRevisionId`` +- ``subtitle`` +- ``translator`` +- ``workNumber`` +- ``workTitle`` vbox ^^^^ @@ -345,26 +345,26 @@ XML structure of a vbox tag: - + Some title text All vbox tags: -- title (v2,3: Title) -- subtitle (v2,3: Subtitle) -- composer (v2,3: Composer) -- lyricist (v2,3: Lyricist) +- ``title`` (v2,3: ``Title``) +- ``subtitle`` (v2,3: ``Subtitle``) +- ``composer`` (v2,3: ``Composer``) +- ``lyricist`` (v2,3: ``Lyricist``) This command line tool bundles some meta data informations: Combined meta data fields: ^^^^^^^^^^^^^^^^^^^^^^^^^^ -- title (1. vbox_title 2. metatag_work_title) -- subtitle (1. vbox_subtitle 2. metatag_movement_title) -- composer (1. vbox_composer 2. metatag_composer) -- lyricist (1. vbox_lyricist 2. metatag_lyricist) +- ``title`` (1. ``vbox_title`` 2. ``metatag_work_title``) +- ``subtitle`` (1. ``vbox_subtitle`` 2. ``metatag_subtitle`` 3. ``metatag_movement_title``) +- ``composer`` (1. ``vbox_composer`` 2. ``metatag_composer``) +- ``lyricist`` (1. ``vbox_lyricist`` 2. ``metatag_lyricist``) Set the meta tag ``composer``: @@ -399,7 +399,7 @@ CLI Usage usage: musescore-manager [-h] [--print-completion {bash,zsh,tcsh}] [-C ] [-b] [-d] [--catch-errors] [-m] [-e FILE_PATH] [-V] [-v] [-k] [--diff] [--print-xml] - [-E ] [--compress] [-c META_CLEAN] [-D] + [-E ] [--compress] [-c ] [-D] [-i ] [-j] [-l ] [-y] [-S ] @@ -474,7 +474,7 @@ CLI Usage meta: Deal with meta data informations stored in the MuseScore file. - -c META_CLEAN, --clean-meta META_CLEAN + -c , --clean-meta Clean the meta data fields. Possible values: „all“ or a comma separated list of fields, for example: „field_one,field_two“. diff --git a/README_template.rst b/README_template.rst index 973a59e..1bdea17 100644 --- a/README_template.rst +++ b/README_template.rst @@ -323,23 +323,23 @@ XML structure of a meta tag: All meta tags: -- arranger -- audioComUrl (new in v4) -- composer -- copyright -- creationDate -- lyricist -- movementNumber -- movementTitle -- mscVersion -- platform -- poet (not in v4) -- source -- sourceRevisionId -- subtitle -- translator -- workNumber -- workTitle +- ``arranger`` +- ``audioComUrl`` (new in v4) +- ``composer`` +- ``copyright`` +- ``creationDate`` +- ``lyricist`` +- ``movementNumber`` +- ``movementTitle`` +- ``mscVersion`` +- ``platform`` +- ``poet`` (not in v4) +- ``source`` +- ``sourceRevisionId`` +- ``subtitle`` +- ``translator`` +- ``workNumber`` +- ``workTitle`` vbox ^^^^ @@ -350,26 +350,26 @@ XML structure of a vbox tag: - + Some title text All vbox tags: -- title (v2,3: Title) -- subtitle (v2,3: Subtitle) -- composer (v2,3: Composer) -- lyricist (v2,3: Lyricist) +- ``title`` (v2,3: ``Title``) +- ``subtitle`` (v2,3: ``Subtitle``) +- ``composer`` (v2,3: ``Composer``) +- ``lyricist`` (v2,3: ``Lyricist``) This command line tool bundles some meta data informations: Combined meta data fields: ^^^^^^^^^^^^^^^^^^^^^^^^^^ -- title (1. vbox_title 2. metatag_work_title) -- subtitle (1. vbox_subtitle 2. metatag_movement_title) -- composer (1. vbox_composer 2. metatag_composer) -- lyricist (1. vbox_lyricist 2. metatag_lyricist) +- ``title`` (1. ``vbox_title`` 2. ``metatag_work_title``) +- ``subtitle`` (1. ``vbox_subtitle`` 2. ``metatag_subtitle`` 3. ``metatag_movement_title``) +- ``composer`` (1. ``vbox_composer`` 2. ``metatag_composer``) +- ``lyricist`` (1. ``vbox_lyricist`` 2. ``metatag_lyricist``) Set the meta tag ``composer``: diff --git a/docs/cli.rst b/docs/cli.rst index 80edab8..673d706 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -7,7 +7,7 @@ Comande line interface usage: musescore-manager [-h] [--print-completion {bash,zsh,tcsh}] [-C ] [-b] [-d] [--catch-errors] [-m] [-e FILE_PATH] [-V] [-v] [-k] [--diff] [--print-xml] - [-E ] [--compress] [-c META_CLEAN] [-D] + [-E ] [--compress] [-c ] [-D] [-i ] [-j] [-l ] [-y] [-S ] @@ -82,7 +82,7 @@ Comande line interface meta: Deal with meta data informations stored in the MuseScore file. - -c META_CLEAN, --clean-meta META_CLEAN + -c , --clean-meta Clean the meta data fields. Possible values: „all“ or a comma separated list of fields, for example: „field_one,field_two“. diff --git a/mscxyz/cli.py b/mscxyz/cli.py index 8a97389..826937e 100644 --- a/mscxyz/cli.py +++ b/mscxyz/cli.py @@ -194,6 +194,7 @@ def _split_lines(self, text: typing.Text, width: int) -> typing.List[str]: meta_group.add_argument( "-c", "--clean-meta", + metavar="", dest="meta_clean", help="Clean the meta data fields. Possible values: „all“ or a comma separated " "list of fields, for example: " @@ -714,7 +715,7 @@ def _split_lines(self, text: typing.Text, width: int) -> typing.List[str]: action.complete = shtab.FILE # type: ignore -def __print_error(error: Exception) -> None: +def _print_error(error: Exception) -> None: msg = "" if isinstance(error, SyntaxError): @@ -969,4 +970,4 @@ def list_styles(version: int) -> None: if not args.general_catch_errors: raise e else: - __print_error(e) + _print_error(e)