Skip to content

Commit 01b8446

Browse files
committed
improve data_url and p2p_address docs
1 parent 0606023 commit 01b8446

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

stackslib/src/config/mod.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2041,13 +2041,16 @@ pub struct NodeConfig {
20412041
/// The publicly accessible URL that this node advertises to peers during the P2P handshake
20422042
/// as its HTTP RPC endpoint. Other nodes or services might use this URL to query the node's API.
20432043
/// ---
2044-
/// @default: `http://{rpc_bind}` (e.g., "http://0.0.0.0:20443" if [`NodeConfig::rpc_bind`] is default).
2044+
/// @default: Derived by adding "http://" prefix to [`NodeConfig::rpc_bind`] value.
2045+
/// @notes: |
2046+
/// - Example: For rpc_bind="0.0.0.0:20443", data_url becomes "http://0.0.0.0:20443".
20452047
pub data_url: String,
20462048
/// The publicly accessible IPv4 address and port that this node advertises to peers for P2P connections.
20472049
/// This might differ from [`NodeConfig::p2p_bind`] if the node is behind NAT or a proxy.
20482050
/// ---
2049-
/// @default: Derived from [`NodeConfig::rpc_bind`] (e.g., "0.0.0.0:20443" if [`NodeConfig::rpc_bind`] is default).
2051+
/// @default: Derived directly from [`NodeConfig::rpc_bind`] value.
20502052
/// @notes: |
2053+
/// - Example: For rpc_bind="0.0.0.0:20443", p2p_address becomes "0.0.0.0:20443".
20512054
/// - The default value derivation might be unexpected, potentially using the
20522055
/// [`NodeConfig::rpc_bind`] address; explicit configuration is recommended if needed.
20532056
pub p2p_address: String,

0 commit comments

Comments
 (0)