Commit 0d6531a
committed
docs: add Key interfaces section to adapters README (#94 review)
src/ README audit gate looks for a `## Key interfaces` (or `## Public
surface`) anchor — the existing README had purpose / table /
extension recipe / layering rationale, but no exported-names section.
Adds a `## Key interfaces` section listing the two exported names:
- AzureOpenAIClient — the LLMClient implementation with notes on
complete() vs complete_json() and the discarded `model` arg
(Azure dispatches by deployment, not model).
- AzureOpenAIConfigError — the construction-time error type,
noting that it batches every missing env var into a single
message instead of failing-and-retrying.
Both already documented in the adapter docstrings; this section
hoists them to the README anchor the audit gate enforces.
Refs #941 parent 21d3f33 commit 0d6531a
1 file changed
Lines changed: 7 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
5 | 12 | | |
6 | 13 | | |
7 | 14 | | |
| |||
0 commit comments