Skip to content

Clarify that variables declarations may override previous ones #381

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.

Sign up for GitHub

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

Closed
wants to merge 4 commits into from
Closed

Clarify that variables declarations may override previous ones #381

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1fa0e1d
Allow for local variable overrides
eemeli May 17, 2023
32767f9
Rewrite based on code review comments
eemeli May 31, 2023
0ea4510
Update spec/formatting.md
eemeli Jun 1, 2023
4548843
Avoid the terms "binds"
eemeli Jun 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions spec/formatting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ To resolve the value of a Variable,
its Name is used to identify either a local variable,
or a variable defined elsewhere.
If a local variable and an externally defined one use the same name,
the local variable takes precedence.
the local variable takes precedence after its variable declaration.
A variable declaration may refer in its expression
to a previous or external variable with the same name as the declaration's target.

It is an error for a local variable definition to
It is an error for a variable declaration to
refer to a local variable that's defined after it in the message.

## Error Handling
Expand Down
14 changes: 14 additions & 0 deletions spec/syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,20 @@ This local variable can then be used in other expressions within the same messag
declaration = let s variable [s] "=" [s] expression
```

Declaration examples:

```
let $foo = {|A literal value|}
```

```
let $foo = {:func opt=$bar}
```

```
let $foo = {$foo :number minimumFractionDigits=2}
```
Copy link
Collaborator

@catamorphism catamorphism May 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though it's explained in the formatting doc, is it worth explaining here as well that in the third example, either there must be a previous in-scope definition of foo, or this declaration is syntactically correct but semantically invalid?

Copy link
Member

@aphillips aphillips May 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A better example would make the second $foo into $bar or perhaps $someNumber, since the point of examples is to demonstrate the syntax.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aphillips Fair point. However, I'd like it if there was some place to put an example like this:

let $foo = {|5|}
let $foo = {$foo :number minimumFractionDigits=2}
{{$foo}}

It would be useful for explaining the meaning of variable resolution if the example said: "If this message resolves to a string, the string is '5.00'." That would show that the $foo on the RHS on the second declaration is not the same as the $foo on the LHS.

Probably the syntax.md document isn't the place for that, since it doesn't show the resolved value of any of the examples.

Anyway, for illustrating the syntax, I'm OK with either or both.


### Selectors

A `match` statement contains one or more **_selectors_**
Expand Down