arti: Better doc for ArtiCombinedConfig

This commit is contained in:
Ian Jackson 2022-05-25 18:46:29 +01:00
parent 2b65e1250e
commit 80ddae3d4b
1 changed files with 3 additions and 1 deletions

View File

@ -117,7 +117,9 @@ impl tor_config::load::TopLevel for ArtiConfig {
type Builder = ArtiConfigBuilder;
}
/// Convenience alias
/// Convenience alias for the config for a whole `arti` program
///
/// Used primarily as a type parameter on calls to [`tor_config::resolve`]
pub type ArtiCombinedConfig = (ArtiConfig, TorClientConfig);
impl ArtiConfig {