From 3698be4ee605e664efa8fe9afe7ba9a8691b01b2 Mon Sep 17 00:00:00 2001
From: Colton Donnelly <colton@donn.io>
Date: Tue, 27 Feb 2024 12:31:58 -0500
Subject: [PATCH] lib.meta.availableOn: add example in documentation

---
 lib/meta.nix | 4 ++++
 1 file changed, 4 insertions(+)

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) &&