-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Closed
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-enhancementCategory: An issue proposing an enhancement or a PR with one.Category: An issue proposing an enhancement or a PR with one.E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Description
In the interests of improving the on-boarding experience for newcomers to Rust, I thought it would be worthwhile to share a personal anecdote of something that was a snag for my own learning.
Apparently I've been trained by Wikipedia/MediaWiki defaults to see red links and think they mean missing page. It took me an embarrassingly long time to realize that struct definitions are perfectly clickable. So for several months while learning Rust I eagerly waited for Rust's docs to be updated with info about their struct definitions.
I have no idea if this is a widespread phenomenon, but remarkably the cognitive dissonance still lingers. I'm also not certain if this warrants filing an issue. Feel free to mark as wontfix :)
retep998 and phanschkennytm, Aaron1011, fhartwig, scottmcm and Feliix42QuietMisdreavus and pickfire
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-enhancementCategory: An issue proposing an enhancement or a PR with one.Category: An issue proposing an enhancement or a PR with one.E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.