From a4c0a0125802b7c30629b8e547a4c9d80adf94d2 Mon Sep 17 00:00:00 2001
From: Pierre-Antoine Champin <pierre-antoine@w3.org>
Date: Tue, 19 Mar 2024 15:01:03 +0100
Subject: [PATCH] improve doc

---
 c14n/src/rdfc10.rs | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/c14n/src/rdfc10.rs b/c14n/src/rdfc10.rs
index a0a5e881..796f31cd 100644
--- a/c14n/src/rdfc10.rs
+++ b/c14n/src/rdfc10.rs
@@ -88,7 +88,8 @@ pub fn normalize_with<H: HashFunction, D: SetDataset, W: io::Write>(
     Ok(())
 }
 
-/// Return a [`Dataset`] isomorphic to `d`, with canonical blank node labels.
+/// Return a [`Dataset`](sophia_api::dataset::Dataset) isomorphic to `d`,
+/// paired with a mapping from original blank node labels to canonical ones.
 ///
 /// This calls [`relabel_with`] with
 ///   - the [SHA-256](Sha256) hash function,
@@ -102,7 +103,8 @@ pub fn relabel<D: SetDataset>(d: &D) -> Result<(C14nQuads<D>, C14nIdMap), C14nEr
     relabel_with::<Sha256, D>(d, DEFAULT_DEPTH_FACTOR, DEFAULT_PERMUTATION_LIMIT)
 }
 
-/// Return a [`Dataset`] isomorphic to `d`, with canonical blank node labels.
+/// Return a [`Dataset`](sophia_api::dataset::Dataset) isomorphic to `d`,
+/// paired with a mapping from original blank node labels to canonical ones.
 ///
 /// This calls [`relabel_with`] with
 ///   - the [SHA-384](Sha384) hash function,
@@ -118,7 +120,8 @@ pub fn relabel_sha384<D: SetDataset>(
     relabel_with::<Sha384, D>(d, DEFAULT_DEPTH_FACTOR, DEFAULT_PERMUTATION_LIMIT)
 }
 
-/// Return a [`Dataset`] isomorphic to `d`, with canonical blank node labels.
+/// Return a [`Dataset`](sophia_api::dataset::Dataset) isomorphic to `d`,
+/// paired with a mapping from original blank node labels to canonical ones.
 ///
 /// The generic parameter `H` determines which [hash function](HashFunction)
 /// the algorithm should use internally
@@ -237,11 +240,11 @@ pub const DEFAULT_DEPTH_FACTOR: f32 = 1.0;
 /// The default value of `permutation_limit` in [`normalize`] and [`relabel`].
 pub const DEFAULT_PERMUTATION_LIMIT: usize = 6;
 
-/// An impl of [`Dataset`] that contains canonical labels for blank nodes,
-/// and guarantees that
+/// An impl of [`Dataset`](sophia_api::dataset::Dataset)
+/// that contains canonical labels for blank nodes.
 pub type C14nQuads<'a, D> = Vec<Spog<C14nTerm<DTerm<'a, D>>>>;
 
-/// A n identifier map as returned by [`relabel`] and [`relabel_with`]
+/// An identifier map as returned by [`relabel`] and [`relabel_with`]
 pub type C14nIdMap = BTreeMap<Rc<str>, BnodeId<Rc<str>>>;
 
 #[derive(Clone, Debug)]