Skip to content

Commit 1eaba4e

Browse files
committed
Fix HRN configuration defaults in docs and table formatting
Updates the documentation in config.rs for better accuracy and  readability. Changes: - Corrected the description of HRN resolution_config from 'Enabled'    to 'Disabled' to align with the actual default value of false. - Realigned the Config defaults table to accommodate longer    type names and improve Markdown rendering. These changes are strictly documentation-focused and do not  alter any runtime behavior.
1 parent ffee7df commit 1eaba4e

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

src/config.rs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -118,18 +118,18 @@ pub(crate) const LNURL_AUTH_TIMEOUT_SECS: u64 = 15;
118118
/// ### Defaults
119119
///
120120
/// | Parameter | Value |
121-
/// |----------------------------------------|--------------------|
122-
/// | `storage_dir_path` | /tmp/ldk_node/ |
123-
/// | `network` | Bitcoin |
124-
/// | `listening_addresses` | None |
125-
/// | `announcement_addresses` | None |
126-
/// | `node_alias` | None |
127-
/// | `trusted_peers_0conf` | [] |
128-
/// | `probing_liquidity_limit_multiplier` | 3 |
129-
/// | `anchor_channels_config` | Some(..) |
130-
/// | `route_parameters` | None |
131-
/// | `tor_config` | None |
132-
/// | `hrn_config` | HumanReadableNamesConfig::default() |
121+
/// |----------------------------------------|--------------------------------------|
122+
/// | `storage_dir_path` | /tmp/ldk_node/ |
123+
/// | `network` | Bitcoin |
124+
/// | `listening_addresses` | None |
125+
/// | `announcement_addresses` | None |
126+
/// | `node_alias` | None |
127+
/// | `trusted_peers_0conf` | [] |
128+
/// | `probing_liquidity_limit_multiplier` | 3 |
129+
/// | `anchor_channels_config` | Some(..) |
130+
/// | `route_parameters` | None |
131+
/// | `tor_config` | None |
132+
/// | `hrn_config` | HumanReadableNamesConfig::default() |
133133
///
134134
/// See [`AnchorChannelsConfig`] and [`RouteParametersConfig`] for more information regarding their
135135
/// respective default values.
@@ -264,7 +264,7 @@ pub struct HumanReadableNamesConfig {
264264
///
265265
/// By default, this uses the `Dns` variant with the following settings:
266266
/// * **DNS Server**: `8.8.8.8:53` (Google Public DNS)
267-
/// * **Resolution Service**: Enabled (`false`)
267+
/// * **Resolution Service**: Disabled (`false`)
268268
pub resolution_config: HRNResolverConfig,
269269
}
270270

0 commit comments

Comments
 (0)