Clarify detect_machine event and variable values#336
Open
Lucas-FManager wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
detect.params.eventand${detect_result}are separate surfaces with different value sets and casing.${detect_result}valuesdetectinganderror, and fixes a smallSWMLtypo in the same section.Root cause
The page listed callback events and showed lowercase
${detect_result}examples without explicitly saying these are separate contracts. That madeREADY,NOT_READY, andfinishedlook like possible${detect_result}values even though they are callback lifecycle events only.Code shape
One MDX documentation page changed. The update is intentionally local to the
detect_machinereference page; no generated code, schemas, runtime behavior, or wire-format casing changed.Security assessment
Low risk: documentation-only change. No executable code, dependency, auth behavior, network request handling, secrets, or customer data path changed.
Verification
rg -n "detect_result|READY|NOT_READY|finished|SWML|SMWL|machine \\| human \\| fax \\| unknown \\| detecting \\| error" fern\\products\\swml\\pages\\reference\\methods\\calling\\detect_machine.mdxgit diff --checkNote: I did not run the full Fern docs check locally because this workspace is a sparse checkout and does not have the full docs dependency/config tree installed.
Fixes #333