-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Open
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 toolsA-technical-debtArea: Internal cleanup workArea: Internal cleanup workT-libsRelevant to the library team, which will review and decide on the PR/issue.Relevant to the library team, which will review and decide on the PR/issue.
Description
A lot of the functions in const_ptr
and mut_ptr
are functionally the same with nearly identical documentation.
Currently, the docs are simply duplicated across both functions, but this can cause issues, such docs getting out of sync, or even functions having identical documentation despite having different safety invariants.
I think we should use the #[doc = include!("file.md")]
pattern here, similar to what is done with the c ffi types.
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 toolsA-technical-debtArea: Internal cleanup workArea: Internal cleanup workT-libsRelevant to the library team, which will review and decide on the PR/issue.Relevant to the library team, which will review and decide on the PR/issue.
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
core: begin deduplicating pointer docs
core: begin deduplicating pointer docs
core: begin deduplicating pointer docs
core: begin deduplicating pointer docs
Rollup merge of rust-lang#141609 - lolbinarycat:core-dedup-ptr-docs-1…
Rollup merge of rust-lang#141609 - lolbinarycat:core-dedup-ptr-docs-1…
12 remaining items