updating docstrings

This commit is contained in:
2020-03-08 02:03:21 +00:00
parent c9632c129a
commit 0d64bf7b83
3 changed files with 0 additions and 25 deletions

Binary file not shown.

View File

@@ -37,10 +37,6 @@ class Lyrics:
def show_summary(self) -> None: def show_summary(self) -> None:
"""Show the average word count for all lyrics """Show the average word count for all lyrics
Returns
-------
None
""" """
all_averages = [] all_averages = []
@@ -77,10 +73,6 @@ class Lyrics:
---------- ----------
group_by : str group_by : str
Parameter to group statistics by. Valid options are album or year Parameter to group statistics by. Valid options are album or year
Returns
-------
None
""" """
stats_obj = getattr(self, f'{group_by}_statistics') stats_obj = getattr(self, f'{group_by}_statistics')
stats = [ stats = [

View File

@@ -64,23 +64,6 @@ def lyrics(
save_output: bool, save_output: bool,
) -> None: ) -> None:
"""Search for lyrics statistics of an Artist/Group. """Search for lyrics statistics of an Artist/Group.
Parameters
----------
ctx : musicbrainzapi.cli.cli.Environment
click environment class
artist : str
artist
country : Union[str, None]
country
dev : bool
dev flag - not to be used
show_summary : str
summary flag - used to display descriptive statistics
wordcloud : bool
wordcloud flag - used to create a wordcloud from lyrics
save_output : bool
save output flag - used to save output locally to disk
""" """
director = LyricsClickDirector() director = LyricsClickDirector()
builder = LyricsBuilder() builder = LyricsBuilder()