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

Suggested tweaks to the supported features docs #797

Merged
merged 5 commits into from May 4, 2021

Conversation

shonfeder
Copy link
Contributor

Some clarifications and slight rewording on the documentation of supported features.

There are also two places where I am not sure what is meant, I'll call those out with comments.

docs/src/apalache/features.md Outdated Show resolved Hide resolved
@@ -62,7 +62,7 @@ Operator | Supported? | Milestone | Comment
`f[e]` | ✔ | - |
`DOMAIN f` | ✔ | - |
`[ x \in S ↦ e]` | ✔ | - |
`[ S -> T ]` | ✔ | - | Sometimes, the functions sets are expanded
`[ S -> T ]` | ✔ | - | Sometimes, the functions sets are expanded <!-- What does this mean? -->
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know what this comment is supposed to mean or what the impact is on users.

Copy link
Contributor

Choose a reason for hiding this comment

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

It is confusing. It means that in some cases functions sets are treated purely symbolically, but sometimes the model checker would try to construct an explicit set of functions, which is exponential. Actually, the model checker would just fail there and will not try to construct such a set. So this sentence is not helping the user.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Cool. That helps. How about

Supported, provided the function can be interpreted symbolically

@shonfeder shonfeder requested a review from konnov May 3, 2021 22:14
Copy link
Contributor

@konnov konnov left a comment

Choose a reason for hiding this comment

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

Looks good! A few things were out of date, so it's good you looked at this doc.

docs/src/apalache/features.md Outdated Show resolved Hide resolved
docs/src/apalache/features.md Outdated Show resolved Hide resolved
docs/src/apalache/features.md Outdated Show resolved Hide resolved
docs/src/apalache/features.md Outdated Show resolved Hide resolved
docs/src/apalache/features.md Outdated Show resolved Hide resolved
docs/src/apalache/features.md Outdated Show resolved Hide resolved
docs/src/apalache/features.md Outdated Show resolved Hide resolved
shonfeder and others added 4 commits May 4, 2021 14:47
@shonfeder shonfeder force-pushed the shon/manual/feature-tweaks branch from 809a9ee to 66baeac Compare May 4, 2021 18:47
@shonfeder shonfeder enabled auto-merge (squash) May 4, 2021 18:53
@shonfeder shonfeder merged commit f7dac3f into unstable May 4, 2021
@shonfeder shonfeder deleted the shon/manual/feature-tweaks branch May 4, 2021 19:33
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.

None yet

2 participants