deduplicate pointer docs with include!
Open
@lolbinarycat is already working on this.
Since Apr 28, 2025.
A-docs
A-technical-debt
T-libs
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.