update example to generate doc output

Author: vadixidav

examples/doc_example.rs

@@ -3,6 +3,7 @@ use header_vec::HeaderVec;
 
 #[derive(Debug)]
 struct OurHeaderType {
+    #[allow(dead_code)]
     a: usize,
 }
 
@@ -13,8 +14,16 @@ fn main() {
     hv.push('z');
 
     println!(
-        "HeaderVec itself consists solely of a pointer, it's only {} bytes big.",
+        "[`HeaderVec`] itself consists solely of a pointer, it's only {} bytes big.",
         size_of_val(&hv)
     );
-    println!("All of the data, like our header, {:?}, and the length of the vector: {}, resides on the other side of the pointer.", &*hv, hv.len());
+    println!(
+        "All of the data, like our header `{:?}`, the length of the vector: `{}`,",
+        &*hv,
+        hv.len()
+    );
+    println!(
+        "and the contents of the vector `{:?}` resides on the other side of the pointer.",
+        hv.as_slice()
+    );
 }

src/lib.rs

@@ -37,8 +37,9 @@ struct HeaderVecHeader<H> {
 /// hv.push('z');
 /// ```
 ///
-/// [`HeaderVec`] itself consists solely of a pointer. It is the same size as a pointer to T.
-/// All of the data, like our header, `OurHeaderType { a: 2 }`, the length of the vector: `2`, and the contents of the vector `['x', 'z']` reside on the other side of the pointer.
+/// [`HeaderVec`] itself consists solely of a pointer, it's only 8 bytes big.
+/// All of the data, like our header `OurHeaderType { a: 2 }`, the length of the vector: `2`,
+/// and the contents of the vector `['x', 'z']` resides on the other side of the pointer.
 pub struct HeaderVec<H, T> {
     ptr: *mut T,
     _phantom: PhantomData<H>,