latest documentation

docs/source/index.rst

@@ -12,17 +12,9 @@ Table of Contents
 
 .. toctree::
    :maxdepth: 2
-   :caption: Modules
+   :caption: API
 
-   modules/musicbrainzapi.rst
+   modules/modules
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Submodules
-
-   modules/musicbrainzapi.api.rst
-   modules/musicbrainzapi.cli.rst
-   modules/musicbrainzapi.wordcloud.rst
 
 .. toctree::
    :caption: Table of Contents

docs/source/modules/musicbrainzapi.api.rst

@@ -1,17 +1,26 @@
-musicbrainzapi.api
+musicbrainzapi.api package
---------------------------------------------------------------------------
+===========================
 
 .. automodule:: musicbrainzapi.api
-   :members:
+    :members:
-   :undoc-members:
+    :undoc-members:
-   :show-inheritance:
+    :show-inheritance:
-   :private-members:
+    :private-members:
 
+Subpackages
+===========
 
 .. toctree::
+    musicbrainzapi.lyrics
 
-   musicbrainzapi.api.lyrics
+Submodules
+==========
 
-.. toctree::
+musicbrainzapi.api.authenticate
+-------------------------------
 
-   musicbrainzapi.api.authenticate
+.. automodule:: musicbrainzapi.api.authenticate
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members:

docs/source/modules/musicbrainzapi.rst

@@ -1,7 +1,5 @@
-.. include:: ../global.rst
+musicbrainzapi 
-
+===============
-musicbrainzapi :modname:`musicbrainzapi`
------------------------------------------
 
 .. automodule:: musicbrainzapi
    :members:
@@ -9,4 +7,10 @@ musicbrainzapi :modname:`musicbrainzapi`
    :show-inheritance:
    :private-members:
 
-Main module text
+Subpackages
+===========
+
+.. toctree::
+    musicbrainzapi.api
+    musicbrainzapi.wordcloud
+

src/musicbrainzapi/cli/cli.py

@@ -42,7 +42,7 @@ class ComplexCLI(click.MultiCommand):
     type=click.Path(
         exists=True, file_okay=False, resolve_path=True, writable=True
     ),
-    help='Path to save results.',
+    help='Local path to save any output files.',
     default=os.getcwd()
 )
 # @click.option('-v', '--verbose', is_flag=True, help='Enables verbose mode.')
@@ -53,7 +53,7 @@ class ComplexCLI(click.MultiCommand):
 )
 @pass_environment
 def cli(ctx, path):
-    """A complex command line interface."""
+    """Base command for the musicbrainzapi program."""
     # ctx.verbose = verbose
     if path is not None:
         click.echo(f'Path set to {os.path.expanduser(path)}')

src/musicbrainzapi/cli/commands/cmd_lyrics.py

@@ -24,7 +24,7 @@ from musicbrainzapi.api.lyrics.director import LyricsClickDirector
 @click.option(
     '--wordcloud',
     required=False,
-    help='Generate a wordcloud from lyrics.',
+    help='Generates a wordcloud from lyrics.',
     is_flag=True,
     default=False,
 )
@@ -41,7 +41,7 @@ from musicbrainzapi.api.lyrics.director import LyricsClickDirector
     required=False,
     multiple=False,
     type=str,
-    help='ISO A-2 Country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha'
+    help='Filter artist by country. This is optional but can narrow down a search if many artists share the same or similar names. Country must be a ISO A-2 Country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha'
     '-2) Example: GB',
 )
 @click.option(
@@ -63,7 +63,7 @@ def lyrics(
     wordcloud: bool,
     save_output: bool,
 ) -> None:
-    """Search for lyrics statistics of an Artist/Group.
+    """Search for lyrics statistics of an Artist/Group. Optionally save the results to disk, and show a wordcloud. Descriptive statistics can be shown in addition to the final average.
     """
     director = LyricsClickDirector()
     builder = LyricsBuilder()