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.

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

Replace libstd, libcore, liballoc terminology in docs #103551

Closed
jsha opened this issue Oct 25, 2022 · 4 comments · Fixed by #103707
Closed

Replace libstd, libcore, liballoc terminology in docs #103551

jsha opened this issue Oct 25, 2022 · 4 comments · Fixed by #103707
Assignees
@jonathanCogan
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

@jsha
Copy link
Contributor

jsha commented Oct 25, 2022 •
edited by rustbot
Loading

There are a few places in the standard library docs that still refer to libstd, libcore, and liballoc; the modern naming for these would be std, core, and alloc. We should update the docs.

$ rg 'libcore|libstd|liballoc' build/x86_64-unknown-linux-gnu/doc/ -l | grep -v '\.rs\.html'
build/x86_64-unknown-linux-gnu/doc/std/backtrace/index.html
build/x86_64-unknown-linux-gnu/doc/std/fmt/trait.Debug.html
build/x86_64-unknown-linux-gnu/doc/std/slice/trait.Concat.html
build/x86_64-unknown-linux-gnu/doc/alloc/index.html
build/x86_64-unknown-linux-gnu/doc/alloc/fmt/trait.Debug.html
build/x86_64-unknown-linux-gnu/doc/alloc/slice/trait.Concat.html
build/x86_64-unknown-linux-gnu/doc/core/sidebar-items1.66.0.js
build/x86_64-unknown-linux-gnu/doc/core/panicking/sidebar-items1.66.0.js
build/x86_64-unknown-linux-gnu/doc/core/panicking/fn.panic.html
build/x86_64-unknown-linux-gnu/doc/search-index1.66.0.js
build/x86_64-unknown-linux-gnu/doc/core/panicking/index.html
build/x86_64-unknown-linux-gnu/doc/core/fmt/trait.Debug.html
build/x86_64-unknown-linux-gnu/doc/core/prelude/index.html
build/x86_64-unknown-linux-gnu/doc/core/index.html
@jsha jsha 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 Oct 25, 2022
@Mark-Simulacrum
Copy link
Member

FWIW, I sometimes find it a lot clearer -- particularly for core -- to say "libcore". That's unambiguously a library, whereas "core" can mean a lot of things otherwise. I think in many cases this doesn't matter, but we should be careful when reviewing the resulting PR from this issue to make sure context is there, not just directly accept a search and replace.

@Rageking8
Copy link
Contributor

@rustbot claim
I will try to replace those that are unambiguous.

@Rageking8
Copy link
Contributor

@rustbot release-assignment
Will leave for another person

@jonathanCogan
Copy link
Contributor

@rustbot claim

@jonathanCogan jonathanCogan mentioned this issue Oct 29, 2022
Merged
@bors bors closed this as completed in 25b1f1c Dec 30, 2022
thomcc pushed a commit to tcdi/postgrestd that referenced this issue May 31, 2023
@matthiaskrgr
Rollup merge of #103707 - jonathanCogan:master, r=m-ou-se
9987eb4 
Replace libstd, libcore, liballoc terminology in docs

Fixes #103551.  I changed line comments containing the outdated terms as well.

It would be great if someone with more experience could weigh in on whether these changes introduce ambiguity as suggested in rust-lang/rust#103551 (comment).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jonathanCogan jonathanCogan

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.

Replace libstd, libcore, liballoc terminology in docs jonathanCogan/fix-103551-replace-libstd
4 participants
@jsha @Mark-Simulacrum @jonathanCogan @Rageking8