From 0d8e2e3546c3d5791077219dfd53d5a7a57edbdb Mon Sep 17 00:00:00 2001 From: Bugen Zhao Date: Tue, 6 Aug 2024 15:22:15 +0800 Subject: [PATCH] add more docs Signed-off-by: Bugen Zhao --- src/common/src/system_param/reader.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/common/src/system_param/reader.rs b/src/common/src/system_param/reader.rs index dbedbcc8d0e3..4c869f7465ce 100644 --- a/src/common/src/system_param/reader.rs +++ b/src/common/src/system_param/reader.rs @@ -21,9 +21,15 @@ use super::{default, ParamValue}; use crate::for_all_params; /// Information about a system parameter. +/// +/// Used to display to users through `pg_settings` system table and `SHOW PARAMETERS` command. pub struct ParameterInfo { pub name: &'static str, pub mutable: bool, + /// The [`ToString`] representation of the parameter value. + /// + /// Certain parameters, such as `license_key`, may be sensitive, and redaction is applied to them in their newtypes. + /// As a result, we get the redacted value here for display. pub value: String, pub description: &'static str, }