Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ dual licensed as above, without any additional terms or conditions.
[`serde`]: https://docs.rs/serde/1.0/serde/index
[`serde_json`]: https://docs.rs/serde_json/1.0/serde_json/enum.Value.html
[`serde_json::Value`]: https://docs.rs/serde_json/1.0/serde_json/enum.Value.html
[`toml`]: https://docs.rs/toml/0.8/toml/enum.Value.html
[`toml::Value`]: https://docs.rs/toml/0.8/toml/enum.Value.html
[`toml`]: https://docs.rs/toml/0.9/toml/enum.Value.html
[`toml::Value`]: https://docs.rs/toml/0.9/toml/enum.Value.html
[`Path`]: https://doc.rust-lang.org/std/path/struct.Path.html
[`PathBuf`]: https://doc.rust-lang.org/std/path/struct.PathBuf.html
6 changes: 3 additions & 3 deletions src/diagnostic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pub trait Diagnostic: Sized {
/// The docs.rs URL for this error
fn url() -> &'static str;

/// Returns the label for the given [`Subject`] if applicable.
/// Returns the label for the given [`Subject`](Diagnostic::Subject) if applicable.
fn labels(&self, subject: &Self::Subject) -> Option<Box<dyn Iterator<Item = Label>>>;
}

Expand Down Expand Up @@ -51,8 +51,8 @@ impl From<Label> for miette::LabeledSpan {
///
/// This type serves two roles:
///
/// 1. **[`PointerBuf::parse`]**: Captures the [`ParseError`] along with the
/// input `String`.
/// 1. **[`PointerBuf::parse`](crate::PointerBuf::parse)**: Captures the
/// [`ParseError`](crate::ParseError) along with the input `String`.
///
/// 2. **Reporting:** Provides enriched reporting capabilities, including
/// (optional) `miette` integration, for `ParseError` and associated errors
Expand Down
8 changes: 4 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
//! [`tokens`]: crate::Pointer::tokens
//! [`components`]: crate::Pointer::components
//! [`resolve`]: crate::resolve
//! [`assign`]: crate::asign
//! [`assign`]: crate::assign
//! [`delete`]: crate::delete
//! [`Resolve`]: crate::resolve::Resolve
//! [`ResolveMut`]: crate::resolve::ResolveMut
Expand All @@ -28,8 +28,8 @@
//! [`serde`]: https://docs.rs/serde/1.0/serde/index
//! [`serde_json`]: https://docs.rs/serde_json/1.0/serde_json/enum.Value.html
//! [`serde_json::Value`]: https://docs.rs/serde_json/1.0/serde_json/enum.Value.html
//! [`toml`]: https://docs.rs/toml/0.8/toml/enum.Value.html
//! [`toml::Value`]: https://docs.rs/toml/0.8/toml/enum.Value.html
//! [`toml`]: https://docs.rs/toml/0.9/toml/enum.Value.html
//! [`toml::Value`]: https://docs.rs/toml/0.9/toml/enum.Value.html
//! [`Path`]: https://doc.rust-lang.org/std/path/struct.Path.html
//! [`PathBuf`]: https://doc.rust-lang.org/std/path/struct.PathBuf.html

Expand Down Expand Up @@ -67,7 +67,7 @@ pub mod diagnostic;
pub use diagnostic::{Diagnose, Report};

mod pointer;
pub use pointer::{ParseError, Pointer, PointerBuf, RichParseError};
pub use pointer::{ParseError, Pointer, PointerBuf, ReplaceError, RichParseError};

mod token;
pub use token::{EncodingError, InvalidEncoding, Token, Tokens};
Expand Down
4 changes: 2 additions & 2 deletions src/pointer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -568,10 +568,10 @@ impl Pointer {
buf
}

// Returns the length of `self` in encoded format.
/// Returns the length of `self` in encoded format.
///
/// This length expresses the byte count of the underlying string that
/// represents the RFC 6091 Pointer. See also [`std::str::len`].
/// represents the RFC 6901 Pointer. See also [`str::len`].
///
/// ## Examples
/// ```
Expand Down
6 changes: 3 additions & 3 deletions src/resolve.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
//! ## Usage
//! [`Resolve`] and [`ResolveMut`] can be used directly or through the
//! [`resolve`](Pointer::resolve) and [`resolve_mut`](Pointer::resolve_mut)
//! methods on [`Pointer`] and [`PointerBuf`](crate::PointerBuf).
//! methods on [`Pointer`] and [`PointerBuf`].
//!
//! ```rust
//! use jsonptr::{Pointer, Resolve, ResolveMut};
Expand Down Expand Up @@ -106,8 +106,8 @@ pub enum Error {
source: ParseIndexError,
},

/// A [`Token`] within the [`Pointer`] contains an [`Index`] which is out of
/// bounds.
/// A [`Token`] within the [`Pointer`] contains an
/// [`Index`](crate::index::Index) which is out of bounds.
///
/// ## Example
/// ```rust
Expand Down
Loading