Skip to content

Implementation of From on Rc incorrectly refers to Arc #113131

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

Jump to bottom
Closed
claytonwramsey opened this issue Jun 28, 2023 · 2 comments · Fixed by #113253
Closed

Implementation of From on Rc incorrectly refers to Arc #113131

claytonwramsey opened this issue Jun 28, 2023 · 2 comments · Fixed by #113253
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

@claytonwramsey
Copy link

Location

The documentation of impl From<CString> for Rc<CStr> writes the following:

Converts a CString into an Rc<CStr> by moving the CString data into a new Arc buffer.

Summary

A quick peek at the implementation of From<CString> for Rc<CStr shows that it uses an Rc as the backing allocation, not an Arc. My guess is that this documentation was copy-pasted from the implementation on Arc and never edited.

The correct revision (if I understand the implementation correctly) would be to substitute Arc for Rc in the documentation.
@claytonwramsey claytonwramsey added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Jun 28, 2023
@tgross35
Copy link
Contributor

A PR would be welcome if you're interested!

@chenyukang chenyukang added the E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. label Jul 1, 2023
@claytonwramsey
Copy link
Author

Sure. I’m on vacation right now, but will get on it when I get back :).

@nurmukhametdaniyar nurmukhametdaniyar mentioned this issue Jul 2, 2023
Merged
@bors bors closed this as completed in 023f72a Jul 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixed documentation of from<CString> for Rc<CStr>: Arc -> Rc nurmukhametdaniyar/rust
3 participants
@chenyukang @tgross35 @claytonwramsey