Commit 58f6c2f
committed
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
74 | 74 | | |
75 | 75 | | |
76 | 76 | | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
77 | 82 | | |
78 | 83 | | |
79 | 84 | | |
| |||
84 | 89 | | |
85 | 90 | | |
86 | 91 | | |
87 | | - | |
88 | | - | |
89 | | - | |
90 | | - | |
91 | | - | |
92 | | - | |
93 | 92 | | |
94 | 93 | | |
95 | 94 | | |
| |||
0 commit comments