Documentation Pull Request (#124)

* Add omitted: In README.md, there is an example of the output of `tidal-wave --help`. Add the new flag, `--transparent` in that example output.
ebb-earl-co · Mar 29, 2024 · 040c778 · 040c778
1 parent 997726b
commit 040c778
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -123,8 +123,9 @@ Usage: python -m tidal_wave [OPTIONS] TIDAL_URL [OUTPUT_DIRECTORY]
 │ --audio-format               [360|Atmos|HiRes|MQA|Lossless|High|Low]  [default: Lossless]                                                                                                                                         │
 │ --loglevel                   [DEBUG|INFO|WARNING|ERROR|CRITICAL]      [default: INFO]                                                                                                                                             │
 │ --include-eps-singles                                                 No-op unless passing TIDAL artist. Whether to include artist's EPs and singles with albums                                                                  │
-│ --no-extra-files                                                      Whether to not even attempt to retrieve artist bio, artist image, album review, or playlist m3u8                                                            │
+│ --no-extra-files                                                      Whether to not even attempt to retrieve artist bio, artist image, album credits, album review, or playlist m3u8                                             │
 │ --no-flatten                                                          Whether to treat playlists or mixes as a list of tracks/videos and, as such, retrieve them independently                                                    │
+| --transparent                                                         Whether to dump JSON responses from TIDAL API; maximum verbosity                                                                                            | 
 │ --install-completion                                                  Install completion for the current shell.                                                                                                                   │
 │ --show-completion                                                     Show completion for the current shell, to copy it or customize the installation.                                                                            │
 │ --help                                                                Show this message and exit.                                                                                                                                 │

diff --git a/tidal_wave/main.py b/tidal_wave/main.py
@@ -59,7 +59,7 @@ def main(
         bool,
         typer.Option(
             "--no-extra-files",
-            help="Whether to not even attempt to retrieve artist bio, artist image, album review, or playlist m3u8",
+            help="Whether to not even attempt to retrieve artist bio, artist image, album credits, album review, or playlist m3u8",
         ),
     ] = False,
     no_flatten: Annotated[