Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

std::Pin documentation missing example #58882

Open
bIgBV opened this issue Mar 2, 2019 · 2 comments
Open

std::Pin documentation missing example #58882

bIgBV opened this issue Mar 2, 2019 · 2 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.

Comments

@bIgBV
Copy link

bIgBV commented Mar 2, 2019

I think the std::Pin documentation is missing an example. Specifically, the Intrusive linked list example. The heading contains references to the example and the the heading Drop guarantee contains the following line:

If your type uses pinning (such as the two examples above),

This leads me to believe that there is a missing example in the documentation.

@jonas-schievink jonas-schievink added C-enhancement Category: An issue proposing an enhancement or a PR with one. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Mar 2, 2019
@MightyPork
Copy link

Was wondering about this too, reading the release notes. Kind of assumed it's "left as an exercise to the reader"

@RalfJung
Copy link
Member

Well, the problem is that implementing the intrusive linked list with a safe API is actually non-trivial. I expect >100 lines. That's why the example is left at the conceptual level.

@jonas-schievink jonas-schievink added the T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. label Mar 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

4 participants