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

Typo in documentation of std::vec: Self should be self (2 times) #92345

Closed
int-e opened this issue Dec 28, 2021 · 2 comments · Fixed by #92399
Closed

Typo in documentation of std::vec: Self should be self (2 times) #92345

int-e opened this issue Dec 28, 2021 · 2 comments · Fixed by #92399
Assignees
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. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Comments

@int-e
Copy link

int-e commented Dec 28, 2021

See the documentation for append here

/// Moves all the elements of `other` into `Self`, leaving `other` empty.

and for append_elements here:

/// Appends elements to `Self` from other buffer.

In both cases, the documentation refers to the object the method is called for, not the type, so it should be using the lower case self. (And maybe other should be in backticks here?)

@BGR360
Copy link
Contributor

BGR360 commented Dec 29, 2021

@rustbot label +A-docs +T-libs +E-easy

@rustbot rustbot added 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. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Dec 29, 2021
@Veeupup
Copy link
Contributor

Veeupup commented Dec 29, 2021

@rustbot claim

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. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants