summaryrefslogtreecommitdiff
path: root/utils/src/env/helpdoc.rs
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-03-19 15:45:47 +0800
committer魏曹先生 <1992414357@qq.com>2026-03-19 15:45:47 +0800
commit021d92a48000e8e04548ef45bad64c753ad0d1b4 (patch)
tree4f35b0f8fc882576e6c722778acff43ccc749699 /utils/src/env/helpdoc.rs
parentf5563c1c8aee3f1d9c0a7c4b5c6d72b6e58e95d4 (diff)
Add helpdoc module for environment variable handling
Diffstat (limited to 'utils/src/env/helpdoc.rs')
-rw-r--r--utils/src/env/helpdoc.rs15
1 files changed, 15 insertions, 0 deletions
diff --git a/utils/src/env/helpdoc.rs b/utils/src/env/helpdoc.rs
new file mode 100644
index 0000000..d9bce2c
--- /dev/null
+++ b/utils/src/env/helpdoc.rs
@@ -0,0 +1,15 @@
+/// Gets the default help documentation setting based on environment variables.
+///
+/// The function checks the JV_HELPDOC environment variable.
+/// If the variable is set to "1", it returns true (enabled).
+/// If the variable is set to any other value, it returns false (disabled).
+/// If the variable is not set, it returns true (enabled by default).
+///
+/// # Returns
+/// A boolean indicating whether help documentation is enabled
+pub fn get_helpdoc_enabled() -> bool {
+ match std::env::var("JV_HELPDOC") {
+ Ok(value) => value == "1",
+ Err(_) => true,
+ }
+}