lib.meta.availableOn: add example in documentation

2024-02-27 12:31:58 -05:00 · 2024-02-27 12:31:58 -05:00 · 3698be4ee6
parent 19bb95a427
commit 3698be4ee6
1 changed files with 4 additions and 0 deletions
--- 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) &&