From d53d01195e88e82d9a88a410e8feb991c1e8179d Mon Sep 17 00:00:00 2001
From: jdx <216188+jdx@users.noreply.github.com>
Date: Sun, 15 Dec 2024 17:31:44 -0600
Subject: [PATCH] docs: improve settings a bit
---
docs/environments/secrets.md | 2 +-
docs/settings.data.ts | 4 ++--
settings.toml | 2 ++
3 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/docs/environments/secrets.md b/docs/environments/secrets.md
index 7d4525a454..e327d73520 100644
--- a/docs/environments/secrets.md
+++ b/docs/environments/secrets.md
@@ -74,4 +74,4 @@ export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
-
+
diff --git a/docs/settings.data.ts b/docs/settings.data.ts
index f683e175d9..b583888ce5 100644
--- a/docs/settings.data.ts
+++ b/docs/settings.data.ts
@@ -14,7 +14,7 @@ export default {
function buildElement(key, props) {
let type = props.type;
type = type.replaceAll("PathBuf", "String");
- let default_ = props.default;
+ let default_ = props.default_docs ?? props.default;
if (default_ === undefined && type === "Bool" && !props.optional) {
default_ = false;
}
@@ -42,7 +42,7 @@ export default {
deprecated: props.deprecated,
enum: props.enum,
env: props.env,
- optional: props.optional,
+ optional: !props.default_docs && props.optional,
type,
};
return ele;
diff --git a/settings.toml b/settings.toml
index 249b15c8e0..40f45544dc 100644
--- a/settings.toml
+++ b/settings.toml
@@ -650,6 +650,8 @@ optional = true
default_docs = "install_only_stripped"
description = "Specify the flavor to use for precompiled binaries."
docs = """
+Specify the flavor to use for precompiled binaries.
+
Options are available here:
"""