From f0d0488f0dbf75fb12ec31c6a9571695e43e2b84 Mon Sep 17 00:00:00 2001 From: iximeow Date: Sat, 22 Jun 2024 12:28:13 -0700 Subject: docs typos --- src/annotation/mod.rs | 4 ++-- src/lib.rs | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) (limited to 'src') diff --git a/src/annotation/mod.rs b/src/annotation/mod.rs index 9edf262..af8b4bf 100644 --- a/src/annotation/mod.rs +++ b/src/annotation/mod.rs @@ -76,7 +76,7 @@ use crate::{Arch, Reader}; use core::fmt::Display; -/// implementors of `DescriptionSink` receive descriptions of an instruction's disassembly process +/// implementers of `DescriptionSink` receive descriptions of an instruction's disassembly process /// and relevant offsets in the bitstream being decoded. descriptions are archtecture-specific, and /// architectures are expected to be able to turn the bit-level `start` and `width` values into a /// meaningful description of bits in the original instruction stream. @@ -131,7 +131,7 @@ pub trait FieldDescription { /// an interface to decode [`Arch::Instruction`] words from a reader of [`Arch::Word`]s, with the /// decoder able to report descriptions of bits or fields in the instruction to a sink implementing /// [`DescriptionSink`]. the sink may be [`NullSink`] to discard provided data. decoding with a -/// `NullSink` should behave identically to `Decoder::decode_into`. implementors are recommended to +/// `NullSink` should behave identically to `Decoder::decode_into`. implementers are recommended to /// implement `Decoder::decode_into` as a call to `AnnotatingDecoder::decode_with_annotation` if /// implementing both traits. pub trait AnnotatingDecoder { diff --git a/src/lib.rs b/src/lib.rs index db438c2..3af5f00 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -38,7 +38,7 @@ pub mod safer_unchecked; /// the minimum set of errors a `yaxpeax-arch` disassembler may produce. /// -/// it is permissible for an implementor of `DecodeError` to have items that return `false` for +/// it is permissible for an implementer of `DecodeError` to have items that return `false` for /// all these functions; decoders are permitted to error in way that `yaxpeax-arch` does not know /// about. pub trait DecodeError: PartialEq + Display + Debug + Send + Sync + 'static { @@ -50,12 +50,12 @@ pub trait DecodeError: PartialEq + Display + Debug + Send + Sync + 'static { /// generally indicate an issue with the instruction itself. this is in contrast to one /// specific operand being invalid for the instruction, or some other issue to do with decoding /// data beyond the top-level instruction. the "opcode"/"operand" distinction is often fuzzy - /// and left as best-effort for decoder implementors. + /// and left as best-effort for decoder implementers. fn bad_opcode(&self) -> bool; /// did the decoder error because an operand of the instruction to decode is invalid? /// /// similar to [`DecodeError::bad_opcode`], this is a subjective distinction and best-effort on - /// the part of implementors. + /// the part of implementers. fn bad_operand(&self) -> bool; /// a human-friendly description of this decode error. fn description(&self) -> &'static str; @@ -160,7 +160,7 @@ pub trait Decoder { /// SAFETY: /// /// while `inst` MUST be left in a state that does not violate Rust's safety guarantees, - /// implementors are NOT obligated to leave `inst` in a semantically meaningful state if + /// implementers are NOT obligated to leave `inst` in a semantically meaningful state if /// decoding fails. if `decode_into` returns an error, callers may find contradictory and /// useless information in `inst`, as well as *stale data* from whatever was passed in. fn decode_into>(&self, inst: &mut A::Instruction, words: &mut T) -> Result<(), A::DecodeError>; -- cgit v1.1