about summary refs log tree commit diff
path: root/lib
diff options
context:
space:
mode:
authorColton Donnelly <colton@donn.io>2024-02-27 12:31:58 -0500
committerColton Donnelly <colton@donn.io>2024-02-27 14:44:38 -0500
commit3698be4ee605e664efa8fe9afe7ba9a8691b01b2 (patch)
treea17f65dc9b91e9e4d12e2ee05330fa79caddad8e /lib
parent19bb95a427a34e000ef66715fd85af4b275ce792 (diff)
downloadnixlib-3698be4ee605e664efa8fe9afe7ba9a8691b01b2.tar
nixlib-3698be4ee605e664efa8fe9afe7ba9a8691b01b2.tar.gz
nixlib-3698be4ee605e664efa8fe9afe7ba9a8691b01b2.tar.bz2
nixlib-3698be4ee605e664efa8fe9afe7ba9a8691b01b2.tar.lz
nixlib-3698be4ee605e664efa8fe9afe7ba9a8691b01b2.tar.xz
nixlib-3698be4ee605e664efa8fe9afe7ba9a8691b01b2.tar.zst
nixlib-3698be4ee605e664efa8fe9afe7ba9a8691b01b2.zip
lib.meta.availableOn: add example in documentation
Diffstat (limited to 'lib')
-rw-r--r--lib/meta.nix4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/meta.nix b/lib/meta.nix
index 5d5f71d6c3cb..f4525a091031 100644
--- a/lib/meta.nix
+++ b/lib/meta.nix
@@ -112,6 +112,10 @@ rec {
           platform, or `meta.platforms` is not present.
 
        2. None of `meta.badPlatforms` pattern matches the given platform.
+
+     Example:
+       lib.meta.availableOn { system = "aarch64-darwin"; } pkg.zsh
+       => true
   */
   availableOn = platform: pkg:
     ((!pkg?meta.platforms) || any (platformMatch platform) pkg.meta.platforms) &&