chore(release): 0.4.0 (#17)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyanilist"
-version = "0.3.1"
+version = "0.4.0"
 description = "Simple AniList API wrapper to fetch media data"
 authors = ["Raventric <[email protected]>"]
 license = "Unlicense"
@@ -38,13 +38,13 @@ backports-strenum = {version = ">=1.3.1", python = "<3.11"}
 [tool.poetry.group.dev.dependencies]
 ruff = "^0.3.2"
 mypy = "^1.9.0"
-types-boltons = "^23.1.0.20240310"
+types-boltons = "^23.1.0.20240331"
 pytest = "^8.1.1"
 pytest-asyncio = "^0.23.5.post1"
 pre-commit = "^3.7.0"
 
 [tool.poetry.group.docs.dependencies]
-mkdocs-material = "^9.5.15"
+mkdocs-material = "^9.5.16"
 mkdocstrings = {extras = ["python"], version = "^0.24.0"}
 mkdocs-autorefs = "^1.0.1"
 
@@ -59,10 +59,6 @@ fixable = ["ALL"]
 strict = true
 pretty = true
 
-[[tool.mypy.overrides]]
-module = ["markdownify"]
-ignore_missing_imports = true
-
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
 

src/pyanilist/_clients/_async.py

@@ -115,7 +115,7 @@ async def _process_description(dictionary: dict[str, Any]) -> dict[str, Any]:
 
         So we do a bit of post processing:
         - Sanitize the resulting descriptions
-        - Introduce two more formats derived from the default, i.e, markdown and plain text
+        - Introduce two more formats derived from the original two, i.e, markdown and plain text
         - Nest our newly acquired 4 descriptions into a single parent dictionary
 
         Example:

src/pyanilist/_clients/_sync.py

@@ -114,7 +114,7 @@ def _process_description(dictionary: dict[str, Any]) -> dict[str, Any]:
 
         So we do a bit of post processing:
         - Sanitize the resulting descriptions
-        - Introduce two more formats derived from the default, i.e, markdown and plain text
+        - Introduce two more formats derived from the original two, i.e, markdown and plain text
         - Nest our newly acquired 4 descriptions into a single parent dictionary
 
         Example:

src/pyanilist/_models.py

@@ -430,13 +430,13 @@ class MediaDescription(ParentModel):
 
     default: str | None = None
     """
-    The default description of the media as returned by AniList.
+    The default description of the media.
     This may or may not contain HTML tags
     """
 
     html: str | None = None
     """
-    The HTML formatted description of the media as returned by AniList
+    The HTML formatted description of the media
     """
 
     markdown: str | None = None
@@ -453,7 +453,7 @@ class MediaDescription(ParentModel):
 
     Note
     ----
-    This will be "lossy" in the sense that things like like italics, bolds, etc
+    This will be "lossy" in the sense that things like like hrefs, italics, bolds, etc
     will also be stripped
     """