Merge pull request #9 from PyBotDevs/fix-single-liner-documentations

Move all single-line function documentations to a single line string

Author: notsniped

api.py

@@ -26,93 +26,71 @@ def get_auctions(self, page: int = 0) -> dict:
         return auctions
 
     def get_player_auctions(self, player_name: str) -> dict:
-        """
-        Returns a `dict` of all Skyblock auctions from a particular player.
-        """
+        """Returns a `dict` of all Skyblock auctions from a particular player."""
         player_uuid = self.get_uuid(player_name)
         api_request = requests.get(f"https://api.hypixel.net/skyblock/auction?key={self.api_key}&player={player_uuid}").content
         player_auctions = json.loads(api_request)
         return player_auctions
 
     def get_recently_ended_auctions(self) -> dict:
-        """
-        Returns a `dict` of all the auctions that have recently ended within 60 seconds.
-        """
+        """Returns a `dict` of all the auctions that have recently ended within 60 seconds."""
         api_request = requests.get("https://api.hypixel.net/skyblock/auctions_ended").content
         recently_ended_auctions = json.loads(api_request)
         return recently_ended_auctions
 
     def get_news(self) -> dict:
-        """
-        Returns a `dict` of the latest Skyblock news from Hypixel.
-        """
+        """Returns a `dict` of the latest Skyblock news from Hypixel."""
         api_request = requests.get(f"https://api.hypixel.net/skyblock/news?key={self.api_key}").content
         news = json.loads(api_request)
         return news
 
     def get_bazaar_data(self) -> dict:
-        """
-        Returns a `dict` of Skyblock bazaar data.
-        """
+        """Returns a `dict` of Skyblock bazaar data."""
         api_request = requests.get(f"https://api.hypixel.net/skyblock/bazaar?key={self.api_key}").content
         bazaar_data = json.loads(api_request)
         return bazaar_data
 
     def get_player_profile(self, player_name: str) -> dict:
-        """
-        Returns a `dict` of profile data on a player.
-        """
+        """Returns a `dict` of profile data on a player."""
         player_uuid = self.get_uuid(player_name)
         api_request = requests.get(f"https://api.hypixel.net/skyblock/profiles?key={self.api_key}&uuid={player_uuid}").content
         player_profile_data = json.loads(api_request)
         return player_profile_data
 
     def get_collections(self) -> dict:
-        """
-        Returns a `dict` of information related to Skyblock Collections.
-        """
+        """Returns a `dict` of information related to Skyblock Collections."""
         api_request = requests.get("https://api.hypixel.net/resources/skyblock/collections").content
         collections_data = json.loads(api_request)
         return collections_data
 
     def get_skills(self) -> dict:
-        """
-        Returns a `dict` of information related to Skyblock Skills.
-        """
+        """Returns a `dict` of information related to Skyblock Skills."""
         api_request = requests.get("https://api.hypixel.net/resources/skyblock/skills").content
         collections_data = json.loads(api_request)
         return collections_data
 
     def get_items(self) -> dict:
-        """
-        Returns a `dict` of information related to Skyblock items.
-        """
+        """Returns a `dict` of information related to Skyblock items."""
         api_request = requests.get("https://api.hypixel.net/resources/skyblock/items").content
         items_data = json.loads(api_request)
         return items_data
 
     def get_mayor_information(self) -> dict:
-        """
-        Returns a `dict` of information regarding the current mayor in Skyblock.
-        """
+        """Returns a `dict` of information regarding the current mayor in Skyblock."""
         api_request = requests.get("https://api.hypixel.net/resources/skyblock/election").content
         mayor_info = json.loads(api_request)
         del mayor_info["current"]
         return mayor_info
 
     def get_current_election(self) -> dict:
-        """
-        Returns a `dict` of information regarding the current election in Skyblock.
-        """
+        """Returns a `dict` of information regarding the current election in Skyblock."""
         api_request = requests.get("https://api.hypixel.net/resources/skyblock/election").content
         election_info = json.loads(api_request)
         del election_info["mayor"]
         return election_info
 
     def get_bingo_event(self) -> dict:
-        """
-        Returns a `dict` of information regarding the current bingo event and goals in Skyblock.
-        """
+        """Returns a `dict` of information regarding the current bingo event and goals in Skyblock."""
         api_request = requests.get("https://api.hypixel.net/resources/skyblock/bingo").content
         bingo_data = json.loads(api_request)
         return bingo_data