Skip to content

Commit 61c2c18

Browse files
committed
update: restructuring information about marked function propagation
1 parent 84bd3dd commit 61c2c18

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/topics/compiler-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,8 +240,8 @@ Allows using the `holdsIn` keyword in contracts to assume that a boolean conditi
240240
Configure how the compiler [reports ignored results](unused-return-value-checker.md):
241241

242242
* `disable`: disables the unused return value checker. (Default)
243-
* `check`: reports warnings for ignored results from marked functions.
244-
* `full`: treats all functions in your project as marked and reports warnings for ignored results.
243+
* `check`: enables the checker, and reports warnings for ignored results from marked functions.
244+
* `full`: enables the checker, and treats all functions in your project as marked and reports warnings for ignored results.
245245

246246
## Kotlin/JVM compiler options
247247

docs/topics/unused-return-value-checker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ You can control how the compiler reports ignored results with the `-Xreturn-valu
5050
It has the following modes:
5151

5252
* `disable` disables the unused return value checker. (Default)
53-
* `check` reports warnings for ignored results from [marked functions](#mark-functions-to-check-ignored-results).
54-
* `full` treats all functions in your project as [marked](#mark-functions-to-check-ignored-results) and reports warnings for ignored results.
53+
* `check` enables the checker, and reports warnings for ignored results from [marked functions](#mark-functions-to-check-ignored-results).
54+
* `full` enables the checker, and treats all functions in your project as [marked](#mark-functions-to-check-ignored-results) and reports warnings for ignored results.
5555

56-
> When you set `-Xreturn-value-checker` to `check` or `full`, the checker also reports ignored results from marked functions in library dependencies.
56+
> All marked functions are propagated as such, and ignored results are reported if the checker is enabled in projects that use your code as a dependency.
5757
>
5858
{style="note"}
5959

0 commit comments

Comments
 (0)