From 1b5de55e5b0eca06f3ac8213d2013e680e6f74fc Mon Sep 17 00:00:00 2001 From: Zack Slayton Date: Fri, 20 Oct 2023 15:10:33 -0400 Subject: [PATCH] doc link fixes --- src/binary/non_blocking/raw_binary_reader.rs | 2 +- src/element/mod.rs | 2 +- src/ion_reader.rs | 2 +- src/lazy/expanded/template.rs | 2 +- src/lazy/system_reader.rs | 9 +++++---- 5 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/binary/non_blocking/raw_binary_reader.rs b/src/binary/non_blocking/raw_binary_reader.rs index 9df56483..2ba3beff 100644 --- a/src/binary/non_blocking/raw_binary_reader.rs +++ b/src/binary/non_blocking/raw_binary_reader.rs @@ -299,7 +299,7 @@ impl Container { /// A raw binary reader that pulls input bytes from a fixed buffer. /// /// If any read operation fails due to the buffer containing incomplete data, that method will -/// return [`IonError::Incomplete`](crate::IonError::Incomplete). +/// return [`IonError::Incomplete`]. /// /// If the buffer (generic type `A`) is a [`Vec`], then data can be appended to it between read /// operations. This can be useful when reading from a data source that is growing over time, such diff --git a/src/element/mod.rs b/src/element/mod.rs index c0cae14c..cb7d0f41 100644 --- a/src/element/mod.rs +++ b/src/element/mod.rs @@ -2,7 +2,7 @@ //! Provides a dynamically typed, materialized representation of an Ion value. //! -//! An [Element](Element) represents an `(annotations, value)` pair, where a `value` is +//! An [Element] represents an `(annotations, value)` pair, where a `value` is //! an Ion `integer`, `float`, `list`, `struct`, etc. //! //! For reference here are a couple other _value_ style APIs for JSON: diff --git a/src/ion_reader.rs b/src/ion_reader.rs index 7a426a54..6582bfd8 100644 --- a/src/ion_reader.rs +++ b/src/ion_reader.rs @@ -80,7 +80,7 @@ pub trait IonReader { /// error is encountered while reading, returns [crate::IonError]. fn read_i64(&mut self) -> IonResult; - /// Attempts to read the current item as an Ion integer and return it as an [`Int`](crate::types::Int). If the + /// Attempts to read the current item as an Ion integer and return it as an [`Int`]. If the /// current item is not an integer or an IO error is encountered while reading, returns /// [crate::IonError]. fn read_int(&mut self) -> IonResult; diff --git a/src/lazy/expanded/template.rs b/src/lazy/expanded/template.rs index 26a642bc..bc7d22d3 100644 --- a/src/lazy/expanded/template.rs +++ b/src/lazy/expanded/template.rs @@ -833,7 +833,7 @@ impl TemplateValue { pub type ExprRange = SmallRange; pub type AnnotationsRange = SmallRange; -/// A range that takes 8 bytes instead of Range's 16. This is useful for cases like +/// A range that takes 8 bytes instead of `Range`'s 16. This is useful for cases like /// annotations where a capacity of 4 billion+ is more than enough. It also implements `Copy`, /// making it possible for enclosing types to also implement `Copy`. #[derive(Clone, Copy, Debug, PartialEq)] diff --git a/src/lazy/system_reader.rs b/src/lazy/system_reader.rs index f744b2a4..b274983b 100644 --- a/src/lazy/system_reader.rs +++ b/src/lazy/system_reader.rs @@ -30,10 +30,11 @@ const SYMBOLS: RawSymbolTokenRef = RawSymbolTokenRef::SymbolId(7); /// which may contain either a scalar value or a lazy container that may itself be traversed. /// /// The values that the reader yields ([`LazyValue`], -/// [`crate::lazy::sequence::LazyBinarySequence`], and [`LazyStruct`]) are immutable -/// references to the data stream, and remain valid until [`LazySystemReader::next_item`] is -/// called again to advance the reader to the next top level value. This means that these references -/// can be stored, read, and re-read as long as the reader remains on the same top-level value. +/// [`LazyBinarySequence`](crate::lazy::sequence::LazyBinarySequence) and +/// [`LazyStruct`](crate::lazy::struct::LazyStruct)), are immutable references to the data stream, +/// and remain valid until [`LazySystemReader::next_item`] is called again to advance the reader to +/// the next top level value. This means that these references can be stored, read, and re-read as +/// long as the reader remains on the same top-level value. /// ``` ///# use ion_rs::IonResult; ///# fn main() -> IonResult<()> {