adds a bit more documentation

Author: chanced

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "jsonptr"
-version = "0.0.6"
+version = "0.0.7"
 edition = "2021"
 description = "Data structures and logic for resolving, assigning, and deleting by JSON Pointers (RFC 6901)"
 documentation = "https://docs.rs/jsonptr"

Cargo.toml

@@ -124,6 +124,9 @@ impl Display for UnresolvableError {
         )
     }
 }
+
+/// Indicates an error occurred while parsing a `usize` (`ParseError`) or the
+/// parsed value was out of bounds for the targeted array.
 #[derive(PartialEq, Eq)]
 pub enum IndexError {
     Parse(ParseError),
@@ -150,6 +153,7 @@ impl From<OutOfBoundsError> for IndexError {
     }
 }
 
+/// ParseError represents an that an error occurred when parsing an index.
 #[derive(PartialEq, Eq)]
 pub struct ParseError {
     pub source: ParseIntError,

src/error.rs

@@ -1,23 +1,28 @@
 use crate::{Error, Pointer};
 use serde_json::Value;
-/// Resolve is implemented by types
+/// Resolve is implemented by types which can resolve a reference to a
+/// `serde_json::Value` from the path in a JSON Pointer.
 pub trait Resolve {
     type Error: std::error::Error + Send + Sync + 'static;
+    /// Resolve a reference to a `serde_json::Value` based on the path in a JSON
+    /// Pointer.
     fn resolve(&self, ptr: &Pointer) -> Result<&Value, Error>;
 }
 impl Resolve for Value {
     type Error = Error;
-    /// Resolve a value based on the path provided by a JSON Pointer.
     fn resolve(&self, ptr: &Pointer) -> Result<&Value, Self::Error> {
         ptr.resolve(self)
     }
 }
 
+/// ResolveMut is implemented by types which can resolve a mutable reference to
+/// a `serde_json::Value` from the path in a JSON Pointer.
 pub trait ResolveMut {
+    /// Resolve a mutable reference to a `serde_json::Value` based on the path
+    /// in a JSON Pointer.
     fn resolve_mut(&mut self, ptr: &Pointer) -> Result<&mut Value, Error>;
 }
 impl ResolveMut for Value {
-    /// Resolve a mutable value based on the path provided by a JSON Pointer.
     fn resolve_mut(&mut self, ptr: &Pointer) -> Result<&mut Value, Error> {
         ptr.resolve_mut(self)
     }