Skip to content

Commit 436295b

Browse files
committed
📝 Stop recommending scriptElicitations() in the strings this PR adds
#274 schedules scriptElicitations() for removal in favour of <Answers>, so the no-provider diagnostic and the new xmd-test paragraph now name only the <Answers> region. §6.16.1's own description of the helper stays: it is still true today, and #274 rewrites it. The site's changed line named no function, but "scripted answers under a test" gestured at the same mechanism, so it now says "answers the document supplies itself" — which is what <Answers> is, and the section describing it sits directly below.
1 parent 42c38d8 commit 436295b

3 files changed

Lines changed: 4 additions & 5 deletions

File tree

‎packages/core/src/elicitation-api.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export const Elicitation: Api<ElicitationApi> = createApi<ElicitationApi>("Elici
6565
"no elicitation provider configured — a host installs one with " +
6666
'yield* Elicitation.around({ *elicit([request], next) { ... } }, { at: "min" }). ' +
6767
"`xmd run` installs the WebForm provider; under `xmd test`, supply the answer " +
68-
"with an <Answers> region or scriptElicitations().",
68+
"with an <Answers> region.",
6969
);
7070
},
7171
});

‎site/routes/docs/components.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -806,8 +806,8 @@ export default define.page(function Components() {
806806
schema defines every response available. Where the question is actually
807807
put to someone is the host's decision, installed through the Elicitation
808808
Api — a browser form under the CLI today, a terminal or an editor
809-
integration later, scripted answers under a test. Swapping one for
810-
another changes no Markdown.
809+
integration later, or answers the document supplies itself. Swapping one
810+
for another changes no Markdown.
811811
</p>
812812
<p>
813813
That is the reason it is contextual rather than an author-facing option.

‎specs/executable-mdx-spec.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5044,8 +5044,7 @@ shape of provider, and replacing one with another changes no executable Markdown
50445044
`xmd test` deliberately installs no provider. A test document that elicits
50455045
without saying what the answer is would otherwise open a browser and wait for
50465046
somebody who is not coming; with none installed it fails immediately, and an
5047-
`<Answers>` region (§6.16.2) or scripted middleware is how a test says what the
5048-
answer is.
5047+
`<Answers>` region (§6.16.2) is how a test says what the answer is.
50495048

50505049
The elicitation path is also callable by a host directly — `elicit({ message,
50515050
schema })`, or the `prepareElicitation`/`runPreparedElicitation` split when the

0 commit comments

Comments
 (0)