From 72d957129d9b575206565b9125f5b9fd4bba3ed2 Mon Sep 17 00:00:00 2001 From: Alex Stokes Date: Thu, 14 Sep 2023 13:30:45 -0600 Subject: [PATCH] clarify what `Network::Custom` means --- ethereum-consensus/src/networks.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/ethereum-consensus/src/networks.rs b/ethereum-consensus/src/networks.rs index a1a8f0e5b..30e94d5f0 100644 --- a/ethereum-consensus/src/networks.rs +++ b/ethereum-consensus/src/networks.rs @@ -1,6 +1,9 @@ /// This module contains support for various Ethereum netowrks. use crate::state_transition::{Context, Error}; +/// `Network` describes one of the established networks this repository supports +/// or otherwise a `Custom` variant that wraps a path to a local configuration file +/// for the custom network (useful for devnets). #[derive(Default, Debug, Clone)] #[cfg_attr(feature = "serde", derive(serde::Deserialize))] #[cfg_attr(feature = "serde", serde(rename_all = "lowercase"))] @@ -20,7 +23,7 @@ impl std::fmt::Display for Network { Self::Sepolia => write!(f, "sepolia"), Self::Goerli => write!(f, "goerli"), Self::Holesky => write!(f, "holesky"), - Self::Custom(name) => write!(f, "{name}"), + Self::Custom(config_file) => write!(f, "custom network with config at `{config_file}`"), } } }