updating docstrings

docs/source/conf.py

@@ -82,7 +82,7 @@ html_theme = "sphinx_rtd_theme"
 html_theme = "sphinx_rtd_theme"
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 html_static_path = ['_static']
-html_context = {'css_files': ['_static/custom.css']}
+# html_context = {'css_files': ['_static/custom.css']}
 html_theme_options = {
     'collapse_navigation': True,
     'display_version': True,

src/musicbrainzapi/api/lyrics/builder.py

@@ -100,10 +100,6 @@ class LyricsBuilder(LyricsConcreteBuilder):
 
     def find_artists(self) -> None:
         """Find artists from the musicbrainz api
-
-        Returns
-        -------
-        None
         """
         self.musicbrainz_artists = musicbrainzngs.search_artists(
             artist=self.artist, country=self.country
@@ -112,10 +108,6 @@ class LyricsBuilder(LyricsConcreteBuilder):
 
     def sort_artists(self) -> None:
         """Sort the artists from the Musicbrainzapi
-
-        Returns
-        -------
-        None
         """
         self._sort_names = dict(
             (i.get('id'), f'{i.get("name")} | {i.get("disambiguation")}')
@@ -127,10 +119,6 @@ class LyricsBuilder(LyricsConcreteBuilder):
 
     def get_accuracy_scores(self) -> None:
         """Get accuracy scores from the Musicbrainzapi
-
-        Returns
-        -------
-        None
         """
         self._accuracy_scores = dict(
             (i.get('id'), int(i.get('ext:score', '0')))
@@ -140,10 +128,6 @@ class LyricsBuilder(LyricsConcreteBuilder):
 
     def get_top_five_results(self) -> None:
         """Get the top five artists from the Musicbrainzapi
-
-        Returns
-        -------
-        None
         """
         self._top_five_results = dict(
             (i, self._accuracy_scores.get(i))
@@ -157,10 +141,6 @@ class LyricsBuilder(LyricsConcreteBuilder):
 
     def find_all_albums(self) -> None:
         """Find all albums for the chosen artist
-
-        Returns
-        -------
-        None
         """
         limit, offset, page = (100, 0, 1)
 
@@ -219,10 +199,6 @@ class LyricsBuilder(LyricsConcreteBuilder):
 
     def find_all_tracks(self) -> None:
         """Find all tracks from all albums.
-
-        Returns
-        -------
-        None
         """
         self.all_albums = list()
         total_albums = len(self.release_group_ids)
@@ -289,10 +265,6 @@ class LyricsBuilder(LyricsConcreteBuilder):
 
     def find_lyrics_urls(self) -> None:
         """Construct the URL for the lyrics api.
-
-        Returns
-        -------
-        None
         """
         self.all_albums_lyrics_url = list()
         for x in self.all_albums:
@@ -313,10 +285,6 @@ class LyricsBuilder(LyricsConcreteBuilder):
 
     def find_all_lyrics(self) -> None:
         """Get lyrics for each track from the lyrics api
-
-        Returns
-        -------
-        None
         """
         self.all_albums_lyrics = list()
 
@@ -342,10 +310,6 @@ class LyricsBuilder(LyricsConcreteBuilder):
 
     def count_words_in_lyrics(self) -> None:
         """Count all words in each track
-
-        Returns
-        -------
-        None
         """
         self.all_albums_lyrics_count = list()
         # print(self.total_track_count)
@@ -374,10 +338,6 @@ class LyricsBuilder(LyricsConcreteBuilder):
 
     def calculate_track_totals(self) -> None:
         """Calculates total words for each track across all albums.
-
-        Returns
-        -------
-        None
         """
         self.all_albums_lyrics_sum = list()
         album_lyrics = self.all_albums_lyrics_count

src/musicbrainzapi/api/lyrics/director.py

@@ -25,17 +25,13 @@ class LyricsClickDirector:
 
     def _get_initial_artists(self, artist: str, country: str) -> None:
         """Search Musicbrainz api for an artist
-        
+
         Parameters
         ----------
         artist : str
             Artist to search for
         country : str
             Country artist comes from.
-        
-        Returns
-        -------
-        None
         """
         self.builder.artist = artist
         self.builder.country = country
@@ -48,11 +44,7 @@ class LyricsClickDirector:
 
     def _confirm_final_artist(self) -> None:
         """Confirm the artist from the user.
-        
+
-        Returns
-        -------
-        None
-        
         Raises
         ------
         SystemExit
@@ -107,10 +99,6 @@ class LyricsClickDirector:
 
     def _query_for_data(self) -> None:
         """Query Musicbrainz api for albums + track data.
-        
-        Returns
-        -------
-        None
         """
         self.builder.find_all_albums()
         self.builder.find_all_tracks()
@@ -119,10 +107,6 @@ class LyricsClickDirector:
 
     def _get_lyrics(self) -> None:
         """Get Lyrics for each track
-        
-        Returns
-        -------
-        None
         """
         self.builder.find_lyrics_urls()
         self.builder.find_all_lyrics()
@@ -144,10 +128,6 @@ class LyricsClickDirector:
 
     def _calculate_basic_statistics(self) -> None:
         """Calculate a basic average for all tracks.
-        
-        Returns
-        -------
-        None
         """
         self.builder.calculate_track_totals()
         self.builder._product.all_albums_lyrics_sum = (
@@ -157,10 +137,6 @@ class LyricsClickDirector:
 
     def _calculate_descriptive_statistics(self) -> None:
         """Calculate descriptive statistics for album and/or year.
-        
-        Returns
-        -------
-        None
         """
         self.builder.calculate_final_average_by_album()
         self.builder.calculate_final_average_by_year()
@@ -170,10 +146,6 @@ class LyricsClickDirector:
 
     def _dev(self) -> None:
         """Dev function - used for testing
-        
-        Returns
-        -------
-        None
         """
         self.builder.calculate_final_average_by_album()
         self.builder.calculate_final_average_by_year()
@@ -188,12 +160,12 @@ class LyricsClickDirector:
     @staticmethod
     def _get_product(builder_inst: LyricsBuilder) -> Lyrics:
         """Returns the constructed Lyrics object
-        
+
         Parameters
         ----------
         builder_inst : LyricsBuilder
             Builder class for Lyrics object
-        
+
         Returns
         -------
         Lyrics