Clarify syntax options; mention interactive help advantage of named

Vectornaut 2025-11-13 23:10:22 +00:00
parent be59748ffc
commit 9c51803b29

@ -32,10 +32,10 @@ We could make regulator references more visually coherent, and help distinguish
#### Creating regulators #### Creating regulators
_Syntax options_
``` ```
Angle a b Angle a b
``` ```
``` ```
regulate Angle a b regulate Angle a b
``` ```
@ -64,6 +64,7 @@ Angle a b @ 30
Set the regulator for the angle between `a` and `b` to 30°, creating the regulator if it doesnt already exist. Set the regulator for the angle between `a` and `b` to 30°, creating the regulator if it doesnt already exist.
_Syntax options_
``` ```
unset Angle a b unset Angle a b
``` ```
@ -77,6 +78,7 @@ Unset the regulator for the angle between `a` and `b`.
#### Assigning identifiers #### Assigning identifiers
_Syntax options_
``` ```
a is Sphere a is Sphere
``` ```
@ -84,8 +86,9 @@ a is Sphere
Sphere named a Sphere named a
``` ```
Create a sphere, as described above, and set its identifier to `a`. Create a sphere, as described above, and set its identifier to `a`. The `is` option follows the strong tradition of putting identifiers on the left, but the `named` option might work better with an interactive help system.
_Syntax options_
``` ```
r is Angle a b r is Angle a b
``` ```
@ -95,6 +98,7 @@ Angle a b named r
Assign the identifier `r` to the regulator for the angle between `a` and `b`, creating the regulator if it doesnt exist already. Assign the identifier `r` to the regulator for the angle between `a` and `b`, creating the regulator if it doesnt exist already.
_Syntax options_
``` ```
a is c a is c
``` ```
@ -106,6 +110,7 @@ Assign the a new identifier, `a`, to the object with the identifier `c`.
#### Nesting identifier assignments #### Nesting identifier assignments
_Syntax options_
``` ```
r is Angle a b is Sphere r is Angle a b is Sphere
``` ```
@ -119,5 +124,3 @@ It seems like this should assign the identifier `r` to the angle between `a` and
- If the language is purely expression-based: - If the language is purely expression-based:
- An `is` expression could return unit, making it semantically inadmissible for nesting. - An `is` expression could return unit, making it semantically inadmissible for nesting.
- An `is` expression could require punctuation for nesting. - An `is` expression could require punctuation for nesting.
The `is` option follows the strong tradition of putting identifiers on the left.