From b9361a24697c1d4de343de9df36470d40998cdc5 Mon Sep 17 00:00:00 2001
From: ltabis <ltabis.pro@gmail.com>
Date: Thu, 18 Apr 2024 17:14:30 +0200
Subject: [PATCH] docs: add ignore to readme

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 42a2d17..77438b3 100644
--- a/README.md
+++ b/README.md
@@ -57,6 +57,14 @@ mod my_module {
     pub fn add(a: rhai::INT, b: rhai::INT) -> rhai::INT {
         a + b
     }
+
+    /// Use the following directive to not generate documentation:
+    ///
+    /// # rhai-autodocs:ignore
+    #[rhai_fn(global)]
+    pub fn dont_care() {
+        println!("nope");
+    }
 }
 
 // 2. Generate the docs with autodocs. This library can be imported as a build dependency into your build script.