fix documentation

pchampin · Oct 24, 2023 · bf2f6b3 · bf2f6b3
1 parent 5433b9f
commit bf2f6b3
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/jsonld/src/loader.rs b/jsonld/src/loader.rs
@@ -2,7 +2,8 @@
 //! * [`NoLoader`]: does not load anything (to be used with self-sufficient JSON-LD documents)
 //! * [`FsLoader`]: loads documents from the file system, by mapping directories to specific URLs
 //! * [`StaticLoader`]: loads a selected set of URLs from memory (useful to embed in a program normative contexts)
-//! * [`SurfLoader`]: loads documents directly from the web (only if the `http_client` feature is enabled)
+//! * [`FileUrlLoader`]: loads documents from file: URLs
+//! * [`HttpLoader`]: loads documents directly from the web (only if the `http_client` feature is enabled)
 //! * [`ChainLoader`]: loads document from the first loader, otherwise falls back to the second one.
 use std::sync::Arc;
 
@@ -30,7 +31,7 @@ pub use file_url_loader::*;
 #[cfg(feature = "http_client")]
 /// A document loader that can load documents from the web.
 ///
-/// See [`jsonl_ld::ReqwestLoader`]
+/// See [`json_ld::ReqwestLoader`]
 pub type HttpLoader =
     json_ld::ReqwestLoader<Iri<Arc<str>>, Location<Iri<Arc<str>>>, Value<Location<Iri<Arc<str>>>>>;
 

diff --git a/jsonld/src/loader/chain_loader.rs b/jsonld/src/loader/chain_loader.rs
@@ -48,7 +48,7 @@ where
     }
 }
 
-/// Error type raised by [`StaticLoader`]
+/// Error type raised by [`ChainLoader`]
 #[derive(thiserror::Error, Debug)]
 #[error("Document not found {0}")]
 pub struct ChainLoaderError<E1, E2>(E1, E2)

diff --git a/jsonld/src/loader/static_loader.rs b/jsonld/src/loader/static_loader.rs
@@ -12,7 +12,7 @@ type MetaVal<I, S> = Meta<JsonVal<I, S>, Location<I, S>>;
 /// A document loader that stores a selected set of documents in memory.
 /// This is useful for stable (e.g. normative) contexts that are expected to be used a lot.
 ///
-/// See https://www.w3.org/TR/json-ld11/#privacy
+/// See <https://www.w3.org/TR/json-ld11/#privacy>
 ///
 /// NB: The type parameter `I` for IRI-indexes is bound to `IsIri`,
 /// meaning that they must allow the IRI to be retrieved without resorting on a [`Vocabulary`](rdf_types::Vocabulary).

diff --git a/jsonld/src/vocabulary.rs b/jsonld/src/vocabulary.rs
@@ -1,4 +1,4 @@
-//! A Sophia-friendly implementation of [`rdf_type::Vocabulary`]
+//! A Sophia-friendly implementation of [`rdf_types::Vocabulary`]
 use std::sync::Arc;
 
 use rdf_types::{