Skip to content

Commit e88a842

Browse files
committed
Rephrase comonadic mode descs
1 parent ad5201a commit e88a842

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

src/analysis/syntax_doc.ml

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,13 @@ let get_mod_bound_doc mod_bound =
155155
| Axis_pair (Modal (Comonadic _), _) ->
156156
Some
157157
(Format.asprintf
158-
"Values of types of this kind can cross to `%s` from weaker modes." mod_bound)
158+
"Values of types of this kind can cross to `%s` from weaker modes."
159+
mod_bound)
159160
| Axis_pair (Modal (Monadic _), _) ->
160161
Some
161162
(Format.asprintf
162-
"Values of types of this kind can cross from `%s` to stronger modes" mod_bound)
163+
"Values of types of this kind can cross from `%s` to stronger modes"
164+
mod_bound)
163165
| Axis_pair (Nonmodal Externality, Internal) ->
164166
Some "Values of types of this kind might be pointers to the OCaml heap"
165167
| Axis_pair (Nonmodal Externality, External64) ->
@@ -214,9 +216,10 @@ let get_mode_doc mode =
214216
let* description =
215217
match (axis, mode) with
216218
| Comonadic Areality, Local ->
217-
Some "This value cannot escape the current region"
219+
Some "Values with this mode cannot escape the current region"
218220
| Comonadic Areality, Regional -> None
219-
| Comonadic Areality, Global -> Some "This value can escape any region"
221+
| Comonadic Areality, Global ->
222+
Some "Values with this mode can escape any region"
220223
| Monadic Contention, Contended ->
221224
Some
222225
"This usage of the value cannot read or write the mutable parts of the \
@@ -231,19 +234,24 @@ let get_mode_doc mode =
231234
value"
232235
| Comonadic Portability, Nonportable ->
233236
Some
234-
"This value cannot be sent to other threads, in order to avoid data \
235-
races."
237+
"Values with this mode cannot be sent to other threads, in order to \
238+
avoid data races."
236239
| Comonadic Portability, Portable ->
237-
Some "This value can be sent to other threads without causing data races"
240+
Some
241+
"Values with this mode can be sent to other threads without causing \
242+
data races"
238243
| Monadic Uniqueness, Aliased ->
239244
Some "This usage of the value might not be the only usage of the value"
240245
| Monadic Uniqueness, Unique ->
241246
Some "This usage of the value is the only usage of the value."
242-
| Comonadic Linearity, Once -> Some "This value can be used at most once"
243-
| Comonadic Linearity, Many -> Some "This value can be used many times"
244-
| Comonadic Yielding, Yielding -> Some "This value can perform an effect"
247+
| Comonadic Linearity, Once ->
248+
Some "Values with this mode can be used at most once"
249+
| Comonadic Linearity, Many ->
250+
Some "Values with this mode can be used many times"
251+
| Comonadic Yielding, Yielding ->
252+
Some "Values with this mode can perform an effect"
245253
| Comonadic Yielding, Unyielding ->
246-
Some "This value cannot perform an effect"
254+
Some "Values with this mode cannot perform an effect"
247255
| Monadic Visibility, Immutable ->
248256
Some
249257
"This usage of the value cannot read or write the mutable parts of the \
@@ -257,11 +265,11 @@ let get_mode_doc mode =
257265
"This usage of the value can read and write the mutable parts of the \
258266
value"
259267
| Comonadic Statefulness, Stateful ->
260-
Some "This value can read and write mutable data"
268+
Some "Values with this mode can read and write mutable data"
261269
| Comonadic Statefulness, Observing ->
262-
Some "This value can read but not write mutable data"
270+
Some "Values with this mode can read but not write mutable data"
263271
| Comonadic Statefulness, Stateless ->
264-
Some "This value cannot read or write mutable data"
272+
Some "Values with this mode cannot read or write mutable data"
265273
in
266274
let doc_url =
267275
let subpage =

0 commit comments

Comments
 (0)