fix: table in docstring

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.3](https://github.com/fbraem/griffe-fastapi/releases/tag/0.1.2) - 2024-11-19
+
+- Fix generated table in docstring.
+
 ## [0.1.2](https://github.com/fbraem/griffe-fastapi/releases/tag/0.1.2) - 2024-11-19
 
 - Add generate_table option to add a table with responses in the docstring.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "griffe-fastapi"
-version = "0.1.2"
+version = "0.1.3"
 description = "Griffe extension for FastAPI."
 authors = ["fbraem <[email protected]>"]
 readme = "README.md"

src/griffe_fastapi/_extension.py

@@ -175,9 +175,10 @@ def on_function_instance(
             if not func.docstring:
                 func.docstring = Docstring("", parent=func)
             sections = func.docstring.parsed
+            table_str = "\n".join(table)
             sections.append(
                 DocstringSectionText(
-                    f"This api can return the following HTTP codes:\n\n{table}",
+                    f"This api can return the following HTTP codes:\n\n{table_str}",
                     title="HTTP Responses",
                 )
             )

tests/test_extension.py

@@ -232,5 +232,5 @@ def get_teams() -> list[str]:
         assert extra["responses"]["200"]["description"] == "Ok"
         assert (
             package.functions["get_teams"].docstring.parsed[1].value
-            == "This api can return the following HTTP codes:\n\n['| Status | Description |', '|--------|-------------|', '| 200 | Ok |']"
+            == "This api can return the following HTTP codes:\n\n| Status | Description |\n|--------|-------------|\n| 200 | Ok |"
         )