Unverified Commit 7b244a40 authored by david-perez's avatar david-perez Committed by GitHub
Browse files

Enclose some types in backticks in `aws-smithy-json` docs (#1203)

* Enclose some types in backticks in `aws-smithy-json` docs

* Fix docs link
parent 058f28e4
Loading
Loading
Loading
Loading
+4 −4
Original line number Diff line number Diff line
@@ -15,13 +15,13 @@ use ErrorReason::*;

/// JSON token parser as a Rust iterator
///
/// This parser will parse and yield exactly one [Token] per iterator `next()` call.
/// This parser will parse and yield exactly one [`Token`] per iterator `next()` call.
/// Validation is done on the fly, so it is possible for it to parse an invalid JSON document
/// until it gets to the first [Error].
/// until it gets to the first [`Error`].
///
/// JSON string values are left escaped in the [Token::ValueString] as an [EscapedStr],
/// JSON string values are left escaped in the [`Token::ValueString`] as an [`EscapedStr`],
/// which is a new type around a slice of original `input` bytes so that the caller can decide
/// when to unescape and allocate into a [String].
/// when to unescape and allocate into a [`String`].
///
/// The parser *will* accept multiple valid JSON values. For example, `b"null true"` will
/// yield `ValueNull` and `ValueTrue`. It is the responsibility of the caller to handle this for
+2 −1
Original line number Diff line number Diff line
@@ -48,7 +48,8 @@ impl Offset {
    }
}

/// Enum representing the different JSON tokens that can be returned by json_token_iter.
/// Enum representing the different JSON tokens that can be returned by
/// [`crate::deserialize::json_token_iter`].
#[derive(Debug, PartialEq)]
pub enum Token<'a> {
    StartArray {