Skip to content

Commit dfdd8f5

Browse files
committed
docs(examples): fix stale count and clarify hard/soft distinction in docstrings
Address pre-PR review findings: module docstring said '3 implemented' (stale after expanding to 9 methods) and described the four rc.1+ methods as simply 'required' without the hard/soft qualifier. Fix both: update list-tools bullet to '9 seller methods', add 'soft-required' language with pointer to RECOMMENDED_METHODS_PER_SPECIALISM, and update the section comment to use 'recommended' terminology consistent with the map name and env-var guidance. https://claude.ai/code/session_01SQEG3PCARK4eKHBbqu4fTS
1 parent 024e095 commit dfdd8f5

1 file changed

Lines changed: 16 additions & 13 deletions

File tree

examples/hello_seller.py

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,18 @@
44
55
* :class:`DecisioningCapabilities` declared on the class body
66
* :class:`SingletonAccounts` for the dev/single-tenant case
7-
* Nine required ``sales-non-guaranteed`` methods — five hard-required
7+
* Nine ``sales-non-guaranteed`` methods — five hard-required
88
(``get_products``, ``create_media_buy``, ``update_media_buy``,
9-
``sync_creatives``, ``get_media_buy_delivery``) plus four required by the
10-
SalesPlatform Protocol for any ``sales-*`` specialism in v6.0 rc.1+
9+
``sync_creatives``, ``get_media_buy_delivery``) plus four soft-required
10+
by the SalesPlatform Protocol in v6.0 rc.1+
1111
(``get_media_buys``, ``list_creative_formats``, ``list_creatives``,
12-
``provide_performance_feedback``). The authoritative source is the
13-
:data:`~adcp.decisioning.dispatch.REQUIRED_METHODS_PER_SPECIALISM` and
14-
:data:`~adcp.decisioning.dispatch.RECOMMENDED_METHODS_PER_SPECIALISM`
15-
maps; ``validate_platform`` checks both at server boot.
12+
``provide_performance_feedback``; in
13+
:data:`~adcp.decisioning.dispatch.RECOMMENDED_METHODS_PER_SPECIALISM`).
14+
The authoritative list is
15+
:data:`~adcp.decisioning.dispatch.REQUIRED_METHODS_PER_SPECIALISM` +
16+
:data:`~adcp.decisioning.dispatch.RECOMMENDED_METHODS_PER_SPECIALISM`;
17+
``validate_platform`` checks both at server boot — hard-fail for the
18+
five, soft-warn for the four.
1619
1720
Run::
1821
@@ -21,7 +24,7 @@
2124
Then:
2225
2326
* MCP discovery: connect with any AdCP MCP buyer
24-
* List tools: should advertise just the 3 implemented + the
27+
* List tools: should advertise the 9 seller methods + the
2528
framework's protocol tools
2629
* Call ``get_products``: returns one product
2730
* Call ``create_media_buy``: returns the success envelope
@@ -242,11 +245,11 @@ def get_media_buy_delivery(
242245
],
243246
}
244247

245-
# ---- v6.0 rc.1 required methods ----------------------------------------
246-
# These four methods are required by the SalesPlatform Protocol for any
247-
# sales-* specialism in v6.0 rc.1+. The stubs below return the minimal
248-
# valid wire shape (empty collections / acknowledged). Wire them to your
249-
# inventory system / analytics pipeline in production.
248+
# ---- v6.0 rc.1 recommended methods (RECOMMENDED_METHODS_PER_SPECIALISM) --
249+
# Staged for promotion to hard-required at v6.0 rc.1 GA. Stubs return the
250+
# minimal valid wire shape. Wire each to your production systems before
251+
# declaring rc.1 compliance (set ADCP_DECISIONING_STRICT_VALIDATE_PLATFORM=1
252+
# in CI to confirm the full surface is present).
250253

251254
def get_media_buys(
252255
self,

0 commit comments

Comments
 (0)