Skip to content

Commit b62bed7

Browse files
committed
Update mode descriptions
1 parent ccd53cf commit b62bed7

File tree

1 file changed

+18
-23
lines changed

1 file changed

+18
-23
lines changed

src/analysis/syntax_doc.ml

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -222,16 +222,14 @@ let get_mode_doc mode =
222222
Some "Values with this mode can escape any region"
223223
| Monadic Contention, Contended ->
224224
Some
225-
"This usage of the value cannot read or write the mutable parts of the \
226-
value (unless they are atomic)"
225+
"The mutable parts of values of this mode cannot be accessed (unless \
226+
they are atomic)"
227227
| Monadic Contention, Shared ->
228228
Some
229-
"This usage of the value can read but not write the mutable parts of \
230-
the value (unless they are atomic)"
229+
"The mutable parts of values of this mode can be read, but not written \
230+
(unless they are atomic)"
231231
| Monadic Contention, Uncontended ->
232-
Some
233-
"This usage of the value can read and write the mutable parts of the \
234-
value"
232+
Some "The mutable parts of values of this mode can be fully accessed"
235233
| Comonadic Portability, Nonportable ->
236234
Some
237235
"Values with this mode cannot be sent to other threads, in order to \
@@ -243,33 +241,30 @@ let get_mode_doc mode =
243241
| Monadic Uniqueness, Aliased ->
244242
Some "There may be multiple pointers to values with this mode"
245243
| Monadic Uniqueness, Unique ->
246-
Some "It is guaranteed that there is only one pointer to values with this mode"
244+
Some
245+
"It is guaranteed that there is only one pointer to values with this \
246+
mode"
247247
| Comonadic Linearity, Once ->
248-
Some "Values with this mode can be used at most once"
248+
Some "Functions with this mode can only be called once"
249249
| Comonadic Linearity, Many ->
250-
Some "Values with this mode can be used many times"
250+
Some "Functions with this mode can be called any number of times"
251251
| Comonadic Yielding, Yielding ->
252-
Some "Values with this mode can perform an effect"
252+
Some "Functions with this mode can jump to effect handlers"
253253
| Comonadic Yielding, Unyielding ->
254-
Some "Values with this mode cannot perform an effect"
254+
Some "Functions within this value will never jump to an effect handler"
255255
| Monadic Visibility, Immutable ->
256-
Some
257-
"This usage of the value cannot read or write the mutable parts of the \
258-
value"
256+
Some "The mutable parts of values of this mode cannot be accessed"
259257
| Monadic Visibility, Read ->
260258
Some
261-
"This usage of the value can read but not write the mutable parts of \
262-
the value"
259+
"The mutable parts of values of this mode can be read, but not written"
263260
| Monadic Visibility, Read_write ->
264-
Some
265-
"This usage of the value can read and write the mutable parts of the \
266-
value"
261+
Some "The mutable parts of values of this mode can be fully accessed"
267262
| Comonadic Statefulness, Stateful ->
268-
Some "Values with this mode can read and write mutable data"
263+
Some "Functions with this mode can read and write mutable data"
269264
| Comonadic Statefulness, Observing ->
270-
Some "Values with this mode can read but not write mutable data"
265+
Some "Functions with this mode can read but not write mutable data"
271266
| Comonadic Statefulness, Stateless ->
272-
Some "Values with this mode cannot read or write mutable data"
267+
Some "Functions with this mode cannot access mutable data"
273268
in
274269
let doc_url =
275270
let subpage =

0 commit comments

Comments
 (0)