Skip to content

Fix type name in doc example for Iter and IterMut #80791

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
merged 2 commits into from
Jan 8, 2021
Merged

Fix type name in doc example for Iter and IterMut #80791

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10180b4
Fix type name in doc example for Iter and IterMut
mrcz Jan 7, 2021
358ef56
Enclose types in comments in backticks
mrcz Jan 7, 2021
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: 4 additions & 4 deletions library/core/src/slice/iter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ fn size_from_ptr<T>(_: *const T) -> usize {
/// Basic usage:
///
/// ```
/// // First, we declare a type which has `iter` method to get the `Iter` struct (&[usize here]):
/// // First, we declare a type which has `iter` method to get the `Iter` struct (&[usize] here):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// // First, we declare a type which has `iter` method to get the `Iter` struct (&[usize] here):
/// // First, we declare a type which has `iter` method to get the `Iter` struct (`&[usize]` here):

/// let slice = &[1, 2, 3];
///
/// // Then, we iterate over it:
Expand Down Expand Up @@ -112,7 +112,7 @@ impl<'a, T> Iter<'a, T> {
///
/// ```
/// // First, we declare a type which has the `iter` method to get the `Iter`
/// // struct (&[usize here]):
/// // struct (&[usize] here):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// // struct (&[usize] here):
/// // struct (`&[usize]` here):

/// let slice = &[1, 2, 3];
///
/// // Then, we get the iterator:
Expand Down Expand Up @@ -167,7 +167,7 @@ impl<T> AsRef<[T]> for Iter<'_, T> {
///
/// ```
/// // First, we declare a type which has `iter_mut` method to get the `IterMut`
/// // struct (&[usize here]):
/// // struct (&[usize] here):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... and so on

/// let mut slice = &mut [1, 2, 3];
///
/// // Then, we iterate over it and increment each element value:
Expand Down Expand Up @@ -246,7 +246,7 @@ impl<'a, T> IterMut<'a, T> {
///
/// ```
/// // First, we declare a type which has `iter_mut` method to get the `IterMut`
/// // struct (&[usize here]):
/// // struct (&[usize] here):
/// let mut slice = &mut [1, 2, 3];
///
/// {
Expand Down