doc: document the key of the returned hash

gdesmott · Feb 8, 2021 · 7b14339 · 7b14339
1 parent a727fbd
commit 7b14339
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -294,6 +294,8 @@ impl Config {
 
     /// Probe all libraries configured in the Cargo.toml
     /// `[package.metadata.system-deps]` section.
+    ///
+    /// The returned hash is using the the `toml` key defining the dependency as key.
     pub fn probe(self) -> Result<HashMap<String, Library>, Error> {
         let (libraries, flags) = self.probe_full()?;