Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document that svs.command is an architectural WME #488

Open
garfieldnate opened this issue Aug 6, 2024 · 1 comment
Open

document that svs.command is an architectural WME #488

garfieldnate opened this issue Aug 6, 2024 · 1 comment

Comments

@garfieldnate
Copy link
Collaborator

A user's SVS command was not getting run. SVS was active, and the user followed the command structures shown in the manual. The manual doesn't actually show examples of productions creating the commands, however, and it turns out that ^command is an architectural WME, which is not immediately clear from the docs. If the user creates a ^command WME on the SVS WME, SVS will ignore it. I'm not happy with that design, but it would be disrusptive to change.

Update the manual chapter on SVS with an example production that creates an SVS command. Note explicitly that the ^command WME is architectural and should be matched on the LHS, not created in the RHS.

While we're at it, let's also mention in the chapter that you have to enable SVS with svs --enable and can disable it with svs --disable.

@garfieldnate garfieldnate changed the title document that svs.command is an architectural WME keep users from accidentally re-creating the ^command architectural WME document that svs.command is an architectural WME Aug 6, 2024
@garfieldnate
Copy link
Collaborator Author

While I'm on the SVS section: we need example CLI inputs. See also #490. We also need example inputs to SML's SendSVSInput.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant