Add code example.

KonradHoeffner · Feb 22, 2023 · 4533723 · 4533723
1 parent 0072b8b
commit 4533723
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/hdt.rs b/src/hdt.rs
@@ -39,6 +39,11 @@ impl Hdt {
     /// FourSectionDictionary with DictionarySectionPlainFrontCoding and SPO order is the only supported implementation.
     /// The format is specified at <https://www.rdfhdt.org/hdt-binary-format/>, however there are some deviations.
     /// The initial HDT specification at <http://www.w3.org/Submission/2011/03/> is outdated and not supported.
+    /// # Example
+    /// ```
+    /// let file = std::fs::File::open("tests/resources/snikmeta.hdt").expect("error opening file");
+    /// let hdt = hdt::Hdt::new(std::io::BufReader::new(file)).unwrap();
+    /// ```
     pub fn new<R: std::io::BufRead>(mut reader: R) -> io::Result<Self> {
         ControlInfo::read(&mut reader)?;
         Header::read(&mut reader)?;