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

Feedback on WF and SF syntax #41

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

alxiong
Copy link

@alxiong alxiong commented Oct 20, 2022

  • Consistent subscript on SF and WF
  • Troubleshooting hints for accidentally redefining them in TLA+ (which I tried to do while learning)

- Consistent subscript on `SF` and `WF`
- Troubleshooting hints for accidentally redefining them in TLA+ (which I tried to do while learning)
@hwayne
Copy link
Owner

hwayne commented Oct 25, 2022

I am obscenely behind, sorry, but I haven't forgotten this

docs/core/tla.rst Outdated Show resolved Hide resolved
Copy link
Owner

@hwayne hwayne left a comment

Choose a reason for hiding this comment

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

Good changes! Two requests:

  1. In line (365) it should still be Next]_vars because it's a direct translation from pluscal.
  2. I'd like to see the spec you wrote that produced the error you included troubleshooting for, just to better understand what went wrong there. Doesn't have to be included in the actual manual, feel free to just attach it in a PR comment.

or
Encountered "SF_" at line X, column Y

It's because you try to redefine operator ``WF_var(A)`` or ``SF_var(A)`` whereas they are already taken keywords.
Copy link
Owner

Choose a reason for hiding this comment

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

Could you provide the spec that you got that caused error to appear?

Copy link
Author

Choose a reason for hiding this comment

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

yes, sorry for the late reply. Has been occupied by work. Will try to update this PR this week. <>[PR updated this week]

Copy link
Author

Choose a reason for hiding this comment

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

This is a little artificial, but there might be cases where developers accidentally declaring some variables or expression whose name start with WF_ or SF_, without realizing its collision with keywords.

Screenshot 2022-11-28 at 11 15 07 AM

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

Successfully merging this pull request may close these issues.

2 participants