Skip to content

Commit 58f6c2f

Browse files
docs: fix Provider.complete docstring Returns rendering
The Returns block on Provider.complete started with "A :class:Response carrying ...", which mkdocstrings' Google-parser misread as a name-type pair: it pulled out "A" as the Name column entry and split the multi-line description across three table rows. Moving the return-value sentence into the prose summary at the top of the docstring (matching the pattern OpenAIProvider.complete already uses) renders cleanly: no spurious Name column entry, single description block.
1 parent 1ae405b commit 58f6c2f

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

src/openarmature/llm/provider.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@ async def complete(
7474
) -> Response:
7575
"""Perform a single completion call.
7676
77+
Returns a :class:`Response` carrying the assistant message,
78+
finish reason, usage, and raw payload. When ``response_schema``
79+
is supplied and the model returns structured content,
80+
``Response.parsed`` carries the validated value.
81+
7782
Args:
7883
messages: The conversation to send. MUST NOT be mutated by
7984
the implementation.
@@ -84,12 +89,6 @@ async def complete(
8489
supplied, the implementation constrains the model's
8590
output to the schema and populates ``Response.parsed``
8691
with the validated value.
87-
88-
Returns:
89-
A :class:`Response` carrying the assistant message, finish
90-
reason, usage, raw payload, and (when ``response_schema``
91-
was supplied and the model returned structured content)
92-
the parsed structured value.
9392
"""
9493
...
9594

0 commit comments

Comments
 (0)