Open
Description
openedon Oct 28, 2024
Location
There are several places this applies, e.g.:
std::ptr::dangling
std::ptr::from_ref
(in the examples)dangling_pointers_from_temporaries
lint
Summary
We have several place in the standard library or as part of lints where we use the term "dangling pointer" without defining it anywhere.
We should have a place where we define what that is, ideally in the standard library, in it's own section, maybe under std::ptr
, so it can be referenced elsewhere.
It should probably have a definition, followed by some bad examples (and maybe how to fix them).
Wikipedia has article on the subject, I don't know if it could serve as a base for our documentation but it may be worth checking it.
Steps
- Add std documentation
- Update existing std docs
- Update lints diagnostics
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Metadata
Assignees
Labels
Area: documentation for any part of the project, including the compiler, standard library, and toolsCall for participation: Hard difficulty. Experience needed to fix: A lot.Call for participation: Help is requested to fix this issue.Relevant to the library team, which will review and decide on the PR/issue.Relevant to the opsem team