Merge pull request #17 from ariel-miculas/fix_doctest

Fix doctest and run doctests in github CI

Author: cgwalters

.github/workflows/ci.yml

@@ -37,6 +37,9 @@ jobs:
         run: cargo build --all-targets
       - name: cargo test
         run: cargo test --all-targets
+      # https://github.com/rust-lang/cargo/issues/6669
+      - name: cargo test --doc
+        run: cargo test --doc
   linting:
     name: Lints, pinned toolchain
     runs-on: ubuntu-latest

Cargo.toml

@@ -20,3 +20,6 @@ serde_json = "1.0.64"
 tar = "0.4.38"
 thiserror = "1"
 oci-spec = "0.7.0"
+
+[dev-dependencies]
+anyhow = "1.0.89"

src/lib.rs

@@ -18,10 +18,11 @@
 //!
 //! ```rust,no_run
 //! # use ocidir::cap_std;
+//! # use anyhow::{anyhow, Result};
 //! # fn main() -> anyhow::Result<()> {
 //! let d = cap_std::fs::Dir::open_ambient_dir("/path/to/ocidir", cap_std::ambient_authority())?;
 //! let d = ocidir::OciDir::open(&d)?;
-//! println!("{:?}", d.read_manifest()?);
+//! println!("{:?}", d.read_index()?.ok_or_else(|| anyhow!("missing Image Index"))?);
 //! # Ok(())
 //! # }
 //! ```