From bd745d045b5a3830184cd3f906b1e25191d41ab3 Mon Sep 17 00:00:00 2001 From: slightlyoutofphase Date: Wed, 31 Mar 2021 22:09:56 -0400 Subject: [PATCH] Adjust readme and doc comments --- README.md | 4 ++-- src/lib.rs | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 79c7f9f..0d3ee54 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ Provides truly zero-cost alternatives to `Iterator::step_by` for both incrementing and decrementing any type that satisfies `RangeBounds`. -The code generated for the two trait methods this crate implements, `inc_by` and `dec_by`, should in the overwhelming majority of cases be nearly or completely identical -to the code that would be generated for an incrementing "step"-based `while` loop or decrementing "step"-based `while` loop, respectively. If you come across a scenario where +The assembly code generated for the two trait methods this crate implements, `inc_by` and `dec_by`, should in the overwhelming majority of cases be nearly or completely identical +to the assembly code that would be generated for an incrementing "step"-based `while` loop or decrementing "step"-based `while` loop, respectively. If you come across a scenario where it is not, please feel free to open an issue about it. **Minimum supported Rust version:** this is a nightly-only crate at the moment due to the use of diff --git a/src/lib.rs b/src/lib.rs index 1310e74..2749008 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -93,7 +93,7 @@ impl Iterator for DecBy { } } -/// A supertrait of [`RangeBounds`](core::ops::RangeBounds) where `T` is `Copy + Default + Step` +/// A subtrait of [`RangeBounds`](core::ops::RangeBounds) where `T` is `Copy + Default + Step` /// that turns implementers of it into an instance of [`IncBy`][crate::IncBy] when /// [`inc_by`](crate::IntoIncBy::inc_by) is called. pub trait IntoIncBy: RangeBounds { @@ -117,7 +117,7 @@ pub trait IntoIncBy: RangeBounds { fn inc_by(self) -> IncBy; } -/// A supertrait of [`RangeBounds`](core::ops::RangeBounds) where `T` is `Copy + Default + Step` +/// A subtrait of [`RangeBounds`](core::ops::RangeBounds) where `T` is `Copy + Default + Step` /// that turns implementers of it into an instance of [`DecBy`][crate::DecBy] when /// [`dec_by`](crate::IntoDecBy::dec_by) is called. pub trait IntoDecBy: RangeBounds {