Skip to content

Commit 78c1208

Browse files
committed
Update exclave desc
1 parent 0385dd6 commit 78c1208

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

src/analysis/syntax_doc.ml

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -295,13 +295,13 @@ let get_modality_doc modality =
295295
match axis with
296296
| Comonadic _ ->
297297
Format.asprintf
298-
"The annotated value's mode is always at least as strong as `%s`, even if its \
299-
container's mode is weaker."
298+
"The annotated value's mode is always at least as strong as `%s`, even \
299+
if its container's mode is weaker."
300300
modality
301301
| Monadic _ ->
302302
Format.asprintf
303-
"The annotated value's mode is always at least as weak as `%s`, even if its \
304-
container's mode is a stronger."
303+
"The annotated value's mode is always at least as weak as `%s`, even \
304+
if its container's mode is a stronger."
305305
modality
306306
in
307307
(Some
@@ -386,16 +386,18 @@ let get_oxcaml_syntax_doc cursor_loc nodes : syntax_info =
386386
| "opt" ->
387387
Some
388388
{ name = "Zero-alloc opt annotation";
389-
description = "Same as [@zero_alloc], but checks during optimized builds only.";
389+
description =
390+
"Same as [@zero_alloc], but checks during optimized builds \
391+
only.";
390392
documentation = doc_url;
391393
level = Advanced
392394
}
393395
| "assume" ->
394396
Some
395397
{ name = "Zero-alloc assume annotation";
396398
description =
397-
"This function is assumed to be zero-alloc, but the \
398-
compiler does not guarantee it.";
399+
"This function is assumed to be zero-alloc, but the compiler \
400+
does not guarantee it.";
399401
documentation = doc_url;
400402
level = Advanced
401403
}
@@ -478,7 +480,8 @@ let get_oxcaml_syntax_doc cursor_loc nodes : syntax_info =
478480
Some
479481
{ name = "Inline never annotation";
480482
description =
481-
"This function will not be inlined. In this file (only), this can be overridden at call sites with [@inlined].";
483+
"This function will not be inlined. In this file (only), this \
484+
can be overridden at call sites with [@inlined].";
482485
documentation = builtin_attrs_doc_url;
483486
level = Advanced
484487
}
@@ -507,13 +510,13 @@ let get_oxcaml_syntax_doc cursor_loc nodes : syntax_info =
507510
Some
508511
{ name = "Inlined always annotation";
509512
description =
510-
"If possible, this function call will be inlined. \
511-
The function must be known to the optimizer (i.e. not an \
512-
indirect call; and if in another source file, the .cmx for that \
513-
file must be available and the function available for inlining \
514-
e.g. by [@inline always] or [@inline available] or the decision \
515-
of the optimizer). This attribute can override [@inline never] \
516-
but only within the same source file.";
513+
"If possible, this function call will be inlined. The function \
514+
must be known to the optimizer (i.e. not an indirect call; and \
515+
if in another source file, the .cmx for that file must be \
516+
available and the function available for inlining e.g. by \
517+
[@inline always] or [@inline available] or the decision of the \
518+
optimizer). This attribute can override [@inline never] but \
519+
only within the same source file.";
517520
documentation = builtin_attrs_doc_url;
518521
level = Advanced
519522
}
@@ -536,19 +539,18 @@ let get_oxcaml_syntax_doc cursor_loc nodes : syntax_info =
536539
Some
537540
{ name = "Inlined never annotation";
538541
description =
539-
"This function call will not be \
540-
inlined, overriding any attribute on the function's \
541-
declaration.";
542+
"This function call will not be inlined, overriding any \
543+
attribute on the function's declaration.";
542544
documentation = builtin_attrs_doc_url;
543545
level = Advanced
544546
}
545547
| "hint" ->
546548
Some
547549
{ name = "Inlined hint annotation";
548550
description =
549-
"If possible, this function call will be inlined, like [@inlined always]. \
550-
However, no warning is emitted \
551-
when inlining is not possible.";
551+
"If possible, this function call will be inlined, like \
552+
[@inlined always]. However, no warning is emitted when \
553+
inlining is not possible.";
552554
documentation = None;
553555
level = Advanced
554556
}
@@ -621,7 +623,9 @@ let get_oxcaml_syntax_doc cursor_loc nodes : syntax_info =
621623
| { attr_name = { txt = "nontail"; _ }; _ } ->
622624
Some
623625
{ name = "nontail annotation";
624-
description = "This function call will be called normally (with a fresh stack frame), despite appearing in tail position";
626+
description =
627+
"This function call will be called normally (with a fresh stack \
628+
frame), despite appearing in tail position";
625629
documentation = stack_allocation_url;
626630
level = Advanced
627631
}
@@ -686,7 +690,9 @@ let get_oxcaml_syntax_doc cursor_loc nodes : syntax_info =
686690
| Before ->
687691
Some
688692
{ name = "Module strengthening";
689-
description = "Mark each type in this module type as equal to the corresponding type in the given module";
693+
description =
694+
"Mark each type in this module type as equal to the corresponding \
695+
type in the given module";
690696
documentation =
691697
syntax_doc_url Oxcaml
692698
"miscellaneous-extensions/module-strengthening/";
@@ -697,7 +703,9 @@ let get_oxcaml_syntax_doc cursor_loc nodes : syntax_info =
697703
| Expression { exp_desc = Texp_exclave _; _ } :: _ ->
698704
Some
699705
{ name = "exclave_";
700-
description = "Delete the current region and excute the following code";
706+
description =
707+
"End the current region; the following code allocates in the outer \
708+
region";
701709
documentation = stack_allocation_url;
702710
level = Advanced
703711
}

0 commit comments

Comments
 (0)