Clarify and expand modes syntax docs #3943
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
riaqn
reviewed
Apr 30, 2025
Comment on lines
+39
to
45
| A mode expression actually contains a specification for each modal axis, whether | ||
| you have written a choice for that axis or not. For axes that are omitted, the | ||
| so-called *legacy* modes are used instead. The legacy modes are as follows: | ||
|
|
||
| ```ocaml | ||
| global aliased many nonportable uncontended unyielding stateful read_write | ||
| ``` |
There was a problem hiding this comment.
This is only true for modes on arrow types. But I think maybe better to move this to another document about semantics.
There was a problem hiding this comment.
Really? There are contexts where these aren't the legacy modes?
Not sure whether this is syntax or semantics. I've always thought of the legacy modes as just syntax ("when you don't specify an axis in a mode expression, you get this one"), but I suppose it also plays into what's accepted in modules, etc.
There was a problem hiding this comment.
Yeah when you write (exp : _ @ local) you are only specifying the locality; the rest are not constrained.
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was reading through this on my way to somewhere else and made some edits.
Review: @riaqn, who I have also requested to add an entry that I don't feel qualified to do myself.