Skip to content

Commit 9cce9fe

Browse files
committed
update docs some more
1 parent 30d09c9 commit 9cce9fe

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

analysis/src/CompletionDecorators.ml

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,24 @@ Alternatively, use the `@@deprecated` decorator to add a deprecation warning to
4141
( "doesNotRaise",
4242
None,
4343
[
44-
{|The `@doesNotRaise` decorator is for reanalyze, a static analysis tool for ReScript that can perform exception analysis.
44+
{|The `@doesNotRaise` decorator is deprecated. Please use `@doesNotThrow` instead.
4545

46-
`@doesNotRaise` is uses to override the analysis and state that an expression does not raise any exceptions,
46+
`@doesNotRaise` is uses to override the analysis and state that an expression does not throw any exceptions,
4747
even though the analysis reports otherwise. This can happen for example in the case of array access where
4848
the analysis does not perform range checks but takes a conservative stance that any access
49-
could potentially raise.
49+
could potentially throw.
50+
[Read more and see examples in the documentation](https://github.com/rescript-association/reanalyze/blob/master/EXCEPTION.md).
51+
> Hint: Did you know you can run an interactive code analysis in your project by running the command `> ReScript: Start Code Analyzer`? Try it!|};
52+
] );
53+
( "doesNotThrow",
54+
None,
55+
[
56+
{|The `@doesNotThrow` decorator is for reanalyze, a static analysis tool for ReScript that can perform exception analysis.
57+
58+
`@doesNotThrow` is uses to override the analysis and state that an expression does not throw any exceptions,
59+
even though the analysis reports otherwise. This can happen for example in the case of array access where
60+
the analysis does not perform range checks but takes a conservative stance that any access
61+
could potentially throw.
5062
[Read more and see examples in the documentation](https://github.com/rescript-association/reanalyze/blob/master/EXCEPTION.md).
5163
> Hint: Did you know you can run an interactive code analysis in your project by running the command `> ReScript: Start Code Analyzer`? Try it!|};
5264
] );
@@ -151,7 +163,7 @@ The `@new` decorator is used whenever you need to bind to a JavaScript class con
151163
[
152164
{|The `@raises` decorator is deprecated. Please use `@throws` instead.
153165

154-
`@raises` acknowledges that a function can raise exceptions that are not caught, and suppresses
166+
`@raises` acknowledges that a function can throw exceptions that are not caught, and suppresses
155167
a warning in that case. Callers of the functions are then subjected to the same rule.
156168
Example `@raises(Exn)` or `@raises([E1, E2, E3])` for multiple exceptions.
157169
[Read more and see examples in the documentation](https://github.com/rescript-association/reanalyze/blob/master/EXCEPTION.md).
@@ -162,7 +174,7 @@ Example `@raises(Exn)` or `@raises([E1, E2, E3])` for multiple exceptions.
162174
[
163175
{|The `@throws` decorator is for reanalyze, a static analysis tool for ReScript that can perform exception analysis.
164176

165-
`@throws` acknowledges that a function can raise exceptions that are not caught, and suppresses
177+
`@throws` acknowledges that a function can throw exceptions that are not caught, and suppresses
166178
a warning in that case. Callers of the functions are then subjected to the same rule.
167179
Example `@throws(Exn)` or `@throws([E1, E2, E3])` for multiple exceptions.
168180
[Read more and see examples in the documentation](https://github.com/rescript-association/reanalyze/blob/master/EXCEPTION.md).

0 commit comments

Comments
 (0)