diff --git a/crates/arti/src/cfg.rs b/crates/arti/src/cfg.rs index ccc60113a..1f23086ae 100644 --- a/crates/arti/src/cfg.rs +++ b/crates/arti/src/cfg.rs @@ -10,7 +10,10 @@ use tor_config::{impl_standard_builder, ConfigBuildError}; use crate::{LoggingConfig, LoggingConfigBuilder}; -/// Default options to use for our configuration. +/// Example file demonstrating our our configuration and the default options. +/// +/// The options in this example file are all commented out; +/// the actual defaults are done via builder attributes in all the Rust config structs. pub const ARTI_EXAMPLE_CONFIG: &str = concat!(include_str!("./arti-example-config.toml"),); /// Structure to hold our application configuration options