Skip to content

Commit

Permalink
Extend the man page description of --[no-]const-arg-checks (chapel-…
Browse files Browse the repository at this point in the history
…lang#24586)

[reviewed by @mppf]

Brad pointed out that we didn't have documentation for the `const` and
default argument intent indirect modification warning. Since the check
is implementation-specific, it doesn't make sense to mention it in the
spec. Brad suggested the man page as a place people are likely to
encounter it in the steady state (and the entry didn't necessarily give
sufficient context to begin with).

Passed a full paratest with futures.
  • Loading branch information
lydia-duncan authored Mar 12, 2024
2 parents c362c75 + d5c0c7a commit 719155d
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions man/chpl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -390,8 +390,12 @@ OPTIONS

**\--[no-]const-arg-checks**

Enable [disable] const argument checks (only when --warn-unstable is also
used)
Enable [disable] const argument checks (only when **--warn-unstable** is
also used). These checks will warn when an argument is inferred to be
`const ref` and is indirectly modified over the course of the function. To
silence the warning for a particular argument, give it a concrete argument
intent (such as `const ref` or `const in`, depending on if the indirect
modification behavior should be preserved or avoided).

**\--[no-]div-by-zero-checks**

Expand Down

0 comments on commit 719155d

Please sign in to comment.