summaryrefslogtreecommitdiffstats
path: root/lib/types.nix
diff options
context:
space:
mode:
Diffstat (limited to 'lib/types.nix')
-rw-r--r--lib/types.nix27
1 files changed, 18 insertions, 9 deletions
diff --git a/lib/types.nix b/lib/types.nix
index 12bf18633e3a..e9bc939478c5 100644
--- a/lib/types.nix
+++ b/lib/types.nix
@@ -328,15 +328,24 @@ rec {
"signedInt${toString bit}" "${toString bit} bit signed integer";
in {
- /* An int with a fixed range.
- *
- * Example:
- * (ints.between 0 100).check (-1)
- * => false
- * (ints.between 0 100).check (101)
- * => false
- * (ints.between 0 0).check 0
- * => true
+ # TODO: Deduplicate with docs in nixos/doc/manual/development/option-types.section.md
+ /**
+ An int with a fixed range.
+
+ # Example
+ :::{.example}
+ ## `lib.types.ints.between` usage example
+
+ ```nix
+ (ints.between 0 100).check (-1)
+ => false
+ (ints.between 0 100).check (101)
+ => false
+ (ints.between 0 0).check 0
+ => true
+ ```
+
+ :::
*/
inherit between;