Skip to content
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.

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

Small errors in the documentation for rchunks_exact and rchunks_exact_mut #60068

Closed
cyrozap opened this issue Apr 18, 2019 · 1 comment · Fixed by #60080
Closed

Small errors in the documentation for rchunks_exact and rchunks_exact_mut #60068

cyrozap opened this issue Apr 18, 2019 · 1 comment · Fixed by #60080
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@cyrozap
Copy link

cyrozap commented Apr 18, 2019

While reading through some documentation I found what appear to be a few copy/paste errors.

rchunks_exact

"beginning of the slice" should be "end of the slice" here:

/// Returns an iterator over `chunk_size` elements of the slice at a time, starting at the
/// beginning of the slice.

The second " of the slice" should be removed from the end of this sentence:

/// chunk, and [`chunks_exact`] for the same iterator but starting at the beginning of the
/// slice of the slice.

rchunks_exact_mut

The second " of the slice" should be removed from the end of this sentence:

/// smaller chunk, and [`chunks_exact_mut`] for the same iterator but starting at the beginning
/// of the slice of the slice.

@hellow554
Copy link
Contributor

hellow554 commented Apr 18, 2019

Hey @cyrozap! You already figured out the correct locations in the sourcecode, why don't you open a PR and fix that? It would be a easy first PR for you and a great opportunity to contribute to Rust.
Is that something you can do?

@jonas-schievink jonas-schievink added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Apr 18, 2019
nathankleyn added a commit to nathankleyn/rust that referenced this issue Apr 18, 2019
The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Centril added a commit to Centril/rust that referenced this issue Apr 18, 2019
Fix small errors in docs for `rchunks_exact` and `rchunks_exact_mut`.

The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Centril added a commit to Centril/rust that referenced this issue Apr 18, 2019
Fix small errors in docs for `rchunks_exact` and `rchunks_exact_mut`.

The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Centril added a commit to Centril/rust that referenced this issue Apr 18, 2019
Fix small errors in docs for `rchunks_exact` and `rchunks_exact_mut`.

The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Centril added a commit to Centril/rust that referenced this issue Apr 18, 2019
Fix small errors in docs for `rchunks_exact` and `rchunks_exact_mut`.

The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Centril added a commit to Centril/rust that referenced this issue Apr 18, 2019
Fix small errors in docs for `rchunks_exact` and `rchunks_exact_mut`.

The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Centril added a commit to Centril/rust that referenced this issue Apr 18, 2019
Fix small errors in docs for `rchunks_exact` and `rchunks_exact_mut`.

The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Centril added a commit to Centril/rust that referenced this issue Apr 19, 2019
Fix small errors in docs for `rchunks_exact` and `rchunks_exact_mut`.

The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Centril added a commit to Centril/rust that referenced this issue Apr 19, 2019
Fix small errors in docs for `rchunks_exact` and `rchunks_exact_mut`.

The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Centril added a commit to Centril/rust that referenced this issue Apr 19, 2019
Fix small errors in docs for `rchunks_exact` and `rchunks_exact_mut`.

The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Centril added a commit to Centril/rust that referenced this issue Apr 19, 2019
Fix small errors in docs for `rchunks_exact` and `rchunks_exact_mut`.

The documentation for `rchunks_exact` said it started at the beginning
of the slice, bit it actually starts at the end of the slice.

In addition, there were a couple of "of the slice of the slice"
duplicate phrases going on for `rchunks_exact` and `rchunks_exact_mut`.

This fixes rust-lang#60068.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants