From 7214a4342100b608debd06638e376f01eed53441 Mon Sep 17 00:00:00 2001 From: dtomlinson Date: Sat, 7 Mar 2020 22:53:45 +0000 Subject: [PATCH] updating docstrings --- pyproject.toml | 3 ++- src/musicbrainzapi/api/lyrics/builder.py | 4 ++-- src/musicbrainzapi/api/lyrics/director.py | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 390c0f8..43a43fe 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,8 @@ description = "Python module to calculate statistics and generate a wordcloud fo license = "MIT" authors = ["dtomlinson "] readme = "/Users/dtomlinson/git-repos/cv/musicbrainzapi/README.rst" - +homepage = "https://github.com/dtomlinson91/musicbrainzapi-cv-airelogic" +repository = "https://github.com/dtomlinson91/musicbrainzapi-cv-airelogic" [tool.poetry.dependencies] python = "^3.7" diff --git a/src/musicbrainzapi/api/lyrics/builder.py b/src/musicbrainzapi/api/lyrics/builder.py index 84a60cf..b87d111 100644 --- a/src/musicbrainzapi/api/lyrics/builder.py +++ b/src/musicbrainzapi/api/lyrics/builder.py @@ -372,8 +372,8 @@ class LyricsBuilder(LyricsConcreteBuilder): click.echo(f'Processed lyrics for {self.total_track_count} tracks.') return self - def calculate_average_all_albums(self) -> None: - """Summary + def calculate_track_totals(self) -> None: + """Calculates total words for each track across all albums. Returns ------- diff --git a/src/musicbrainzapi/api/lyrics/director.py b/src/musicbrainzapi/api/lyrics/director.py index 1918690..fd1957b 100644 --- a/src/musicbrainzapi/api/lyrics/director.py +++ b/src/musicbrainzapi/api/lyrics/director.py @@ -149,7 +149,7 @@ class LyricsClickDirector: ------- None """ - self.builder.calculate_average_all_albums() + self.builder.calculate_track_totals() self.builder._product.all_albums_lyrics_sum = ( self.builder.all_albums_lyrics_sum )