From 7b143394ca897b28d2ccefdb5ea5b5244e88d158 Mon Sep 17 00:00:00 2001
From: Guillaume Desmottes <guillaume.desmottes@collabora.com>
Date: Mon, 8 Feb 2021 12:47:03 +0100
Subject: [PATCH] doc: document the key of the returned hash

---
 src/lib.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index d12e63e..434f927 100644
--- 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()?;