Update documentation

README.md

@@ -16,7 +16,8 @@ SYNOPSIS
     discogs-tag tag RELEASE <flags>
 
 DESCRIPTION
-    Tag the audio files with the given Discogs release.
+    The skip flag can take one or more of the following values, comma-separated:
+        artist, composer, title, position, date, subtrack, album, genre, albumartist
 
 POSITIONAL ARGUMENTS
     RELEASE
@@ -28,22 +29,13 @@ FLAGS
         Default: False
     -i, --ignore=IGNORE
         Default: False
-    --skip_artist=SKIP_ARTIST
-        Default: False
-    --skip_title=SKIP_TITLE
-        Default: False
-    --skip_composer=SKIP_COMPOSER
-        Default: False
-    --skip_position=SKIP_POSITION
-        Default: False
-    --skip_year=SKIP_YEAR
-        Default: False
-    --skip_subtrack=SKIP_SUBTRACK
-        Default: False
+    -s, --skip=SKIP
+        Type: Optional[]
+        Default: None
 
 NOTES
     You can also use flags syntax for POSITIONAL ARGUMENTS
-```
+q```
 ```shell
 NAME
     discogs-tag copy - Copy the audio tags from source to destination folders.
@@ -52,7 +44,8 @@ SYNOPSIS
     discogs-tag copy SRC <flags>
 
 DESCRIPTION
-    Copy the audio tags from source to destination folders.
+    The skip flag can take one or more of the following values, comma-separated:
+        artist, composer, title, position, date, subtrack, album, genre, albumartist
 
 POSITIONAL ARGUMENTS
     SRC
@@ -64,18 +57,9 @@ FLAGS
         Default: False
     -i, --ignore=IGNORE
         Default: False
-    --skip_artist=SKIP_ARTIST
-        Default: False
-    --skip_title=SKIP_TITLE
-        Default: False
-    --skip_composer=SKIP_COMPOSER
-        Default: False
-    --skip_position=SKIP_POSITION
-        Default: False
-    --skip_year=SKIP_YEAR
-        Default: False
-    --skip_subtrack=SKIP_SUBTRACK
-        Default: False
+    -s, --skip=SKIP
+        Type: Optional[]
+        Default: None
 
 NOTES
     You can also use flags syntax for POSITIONAL ARGUMENTS

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "discogs-tag"
-version = "0.3.1"
+version = "0.3.2"
 description = "A rudimentary audio tagger based on Discogs metadata."
 authors = ["infojunkie <[email protected]>"]
 readme = "README.md"

src/discogs_tag/cli.py

@@ -31,7 +31,12 @@ def tag(
   ignore=False,
   skip=None
 ):
-  """Tag the audio files with the given Discogs release."""
+  """Tag the audio files with the given Discogs release.
+
+  The skip flag can take one or more of the following values, comma-separated:
+      artist, composer, title, position, date, subtrack, album, genre, albumartist
+
+  """
   options = parse_options(locals())
   request = urllib.request.Request(f'https://api.discogs.com/releases/{release}', headers = {
     'User-Agent': f'{__NAME__} {__VERSION__}'
@@ -48,11 +53,14 @@ def copy(
   ignore=False,
   skip=None
 ):
-  """Copy the audio tags from source to destination folders."""
+  """Copy the audio tags from source to destination folders.
+
+  The skip flag can take one or more of the following values, comma-separated:
+      artist, composer, title, position, date, subtrack, album, genre, albumartist
+
+  """
   options = parse_options(locals())
   src_files = get_files(src)
-  pprint(src_files)
-  return
   if not src_files:
     raise Exception(f'No source files found at {src}. Aborting.')