Auto merge of #12239 - weihanglo:source-registry-doc, r=epage

docs: doc comments for registry source and index
rust-lang · Jun 7, 2023 · a8ed33f · a8ed33f
2 parents 527c948 + 7888167
commit a8ed33f
Show file tree

Hide file tree

Showing 3 changed files with 381 additions and 204 deletions.
diff --git a/src/cargo/sources/config.rs b/src/cargo/sources/config.rs
@@ -14,7 +14,9 @@ use log::debug;
 use std::collections::{HashMap, HashSet};
 use url::Url;
 
-/// Represents the entire `[source]` table in Cargo configuration.
+/// Represents the entire [`[source]` replacement table][1] in Cargo configuration.
+///
+/// [1]: https://doc.rust-lang.org/nightly/cargo/reference/config.html#source
 #[derive(Clone)]
 pub struct SourceConfigMap<'cfg> {
     /// Mapping of source name to the toml configuration.