Skip to content

docs(parse): Rely on intra-doc links #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
epage merged 1 commit into from
Mar 3, 2023
Merged

docs(parse): Rely on intra-doc links #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 1 addition & 7 deletions crates/anstyle-parse/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@
//! * Only supports 7-bit codes. Some 8-bit codes are still supported, but they no longer work in
//! all states.
//!
//! [`Parser`]: struct.Parser.html
//! [`Perform`]: trait.Perform.html
//! [Paul Williams' ANSI parser state machine]: https://vt100.net/emu/dec_ansi_parser
#![cfg_attr(feature = "core", no_std)]

Expand Down Expand Up @@ -58,8 +56,6 @@ const MAX_OSC_PARAMS: usize = 16;
const MAX_OSC_RAW: usize = 1024;

/// Parser for raw _VTE_ protocol which delegates actions to a [`Perform`]
///
/// [`Perform`]: trait.Perform.html
#[derive(Default)]
pub struct Parser<C = DefaultCharAccumulator> {
state: State,
Expand Down Expand Up @@ -99,8 +95,6 @@ where
/// Advance the parser state
///
/// Requires a [`Perform`] in case `byte` triggers an action
///
/// [`Perform`]: trait.Perform.html
#[inline]
pub fn advance<P: Perform>(&mut self, performer: &mut P, byte: u8) {
// Utf8 characters are handled out-of-band.
Expand Down Expand Up @@ -390,7 +384,7 @@ impl<'a> utf8::Receiver for VtUtf8Receiver<'a> {
}
}

/// Performs actions requested by the Parser
/// Performs actions requested by the [`Parser`]
///
/// Actions in this case mean, for example, handling a CSI escape sequence describing cursor
/// movement, or simply printing characters to the screen.
Expand Down