Fix docstring formatting issues

Author: Electronic-Mango

src/simplejustwatchapi/justwatch.py

@@ -1,9 +1,11 @@
 """Main module orchestrating requests to JustWatch GraphQL API.
 Currently supported requests are:
+
  - ``search`` - search for entries via title
  - ``details`` - get details for given node ID
  - ``offers_for_countries`` - get all offers for entry with given node ID,
    can look for offers for multiple countries
+
 """
 
 from httpx import post
@@ -82,18 +84,20 @@ def offers_for_countries(
 
     Country codes passed as argument are case-insensitive, however keys in returned dict will match
     them exactly. E.g. for countries specified as:
+
     .. code-block:: python
 
         {"uK", "Us", "AU", "ca"}
 
     returned dict will have the following structure:
+
     .. code-block:: python
 
         {
-            "uK": [... offers ...],
-            "Us": [... offers ...],
-            "AU": [... offers ...],
-            "ca": [... offers ...],
+            "uK": [ ... offers ... ],
+            "Us": [ ... offers ... ],
+            "AU": [ ... offers ... ],
+            "ca": [ ... offers ... ],
         }
 
     ``best_only`` allows filtering out redundant offers, e.g. when if provide offers service

src/simplejustwatchapi/query.py

@@ -1,6 +1,11 @@
 """Module responsible for creating GraphQL queries and parsing responses from JustWatch GraphQL API.
 Parsed responses are returned as Python NamedTuples for easier access.
-Currently only responses from "GetSearchTitles" query are supported.
+Currently supported queries are:
+
+ - ``GetTitleNode``
+ - ``GetSearchTitles``
+ - ``GetTitleOffers``
+
 """
 
 from typing import NamedTuple
@@ -149,7 +154,8 @@
 
 
 class OfferPackage(NamedTuple):
-    """Parsed single offer package from JustWatch GraphQL API for single entry."""
+    """Parsed single offer package from JustWatch GraphQL API for single entry.
+    Contains information about platform on which given offer is available."""
 
     id: str
     package_id: int
@@ -159,7 +165,8 @@ class OfferPackage(NamedTuple):
 
 
 class Offer(NamedTuple):
-    """Parsed single offer from JustWatch GraphQL API for single entry."""
+    """Parsed single offer from JustWatch GraphQL API for single entry.
+    One platform can have multiple offers for one entry available, e.g. renting, buying, etc."""
 
     id: str
     monetization_type: str