Repository navigation
[docs] core::global_allocator should link to std::alloc::GlobalAlloc #77100
Description
Seaching for global_allocator in the docs only surfaces core::global_allocator. This surfaces no information on how to use it, since all that info is part of std::alloc::GlobalAlloc.
The solution seems to link from global_allocator to GlobalAlloc so people can read more. However I'm not sure how to create a link between these since they live in separate crates. What's the right way to go about this?
edit: if someone wants to pick this up, please do. This is probably a "good first issue" once we figure out how to link between the two.
Screenshots
References
- 2018 guide on allocators -- this is how I eventually learned about
GlobalAlloc; ideally it'd be easier to find.
Metadata
Metadata
Assignees
Labels
Area: Documentation for any part of the project, including the compiler, standard library, and toolsCategory: An issue proposing an enhancement or a PR with one.Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.[DEPRECATED; DO NOT USE]
Activity
[-][docs] core::global_allocator should link to std::alloc::GlobalAlloc[/-][+][docs] `core::global_allocator` should link to `std::alloc::GlobalAlloc`[/+]jyn514 commentedon Sep 23, 2020
These can't use intra-doc links, so you need to use relative links. I think
../std/alloc/trait.GlobalAlloc.htmlwould work.jyn514 commentedon Sep 23, 2020
Mentoring instructions: At
rust/library/core/src/macros/mod.rs
Line 1367 in 383da5e
add a link to
../std/alloc/trait.GlobalAlloc.html.mightyiam commentedon Sep 24, 2020
Could I take this on as my first issue?
yoshuawuyts commentedon Sep 24, 2020
@mightyiam please do!
LeSeulArtichaut commentedon Sep 25, 2020
Feel free to use the
@rustbot claimcommand to assign the issue to yourself and show you're working on itmightyiam commentedon Sep 26, 2020
@rustbot claim
Rollup merge of rust-lang#77219 - mightyiam:issue_77100, r=jyn514
yoshuawuyts commentedon Oct 6, 2020
yay; thanks for landing this @mightyiam!