Skip to content

Commit

Permalink
docs: contracts Conan option default value description improved
Browse files Browse the repository at this point in the history
  • Loading branch information
mpusz committed Nov 19, 2024
1 parent 8c39e02 commit 6fde5ec
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/getting_started/installation_and_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,12 @@ dependencies by other means, some modifications to the library's CMake files mig

[`contracts`](#contracts){ #contracts }

: [:octicons-tag-24: 2.2.0][conan contracts] · :octicons-milestone-24: `none`/`gsl-lite`/`ms-gsl` (Default: `gsl-lite`)
: [:octicons-tag-24: 2.2.0][conan contracts] · :octicons-milestone-24: `none`/`gsl-lite`/`ms-gsl` (Default: _see below_)

Enables checking of preconditions and additional asserts in the code.
Enables checking of preconditions and additional assertions in the code.

If the automatically determined default for `import_std` is `True`, then the `contracts` option
is set to `none` by default. `gsl-lite` otherwise.

[conan contracts]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0

Expand Down

0 comments on commit 6fde5ec

Please sign in to comment.