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

Outdated documentation for feature lang_items #110274

Closed
kadiwa4 opened this issue Apr 13, 2023 · 4 comments · Fixed by #113715
Closed

Outdated documentation for feature lang_items #110274

kadiwa4 opened this issue Apr 13, 2023 · 4 comments · Fixed by #113715
Assignees
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-lang-item Area: Language items

Comments

@kadiwa4
Copy link
Contributor

kadiwa4 commented Apr 13, 2023

Location

src/doc/unstable-book/src/language-features/lang-items.md or https://doc.rust-lang.org/unstable-book/language-features/lang-items.html

Summary

The examples don't compile and the list of lang items is outdated.

Should the list at the bottom of the page still be updated? The amount of language items has grown and there's already a list here in the source code.

@kadiwa4 kadiwa4 added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Apr 13, 2023
@kadiwa4
Copy link
Contributor Author

kadiwa4 commented Apr 13, 2023

@rustbot claim
@rustbot label: +A-lang-item

@rustbot rustbot added the A-lang-item Area: Language items label Apr 13, 2023
@jyn514
Copy link
Member

jyn514 commented Apr 13, 2023

I think linking to the source code is better than trying to keep the list up to date, yes. We might still want to document the language items that are required for a no_std binary, since those are "user facing" in a way the others aren't.

@jyn514
Copy link
Member

jyn514 commented Apr 13, 2023

Ideally we could find a way to run rustdoc on the examples (as doctests) so they don't get outdated.

@kadiwa4
Copy link
Contributor Author

kadiwa4 commented Apr 13, 2023

The no_std guidance could be added to the nomicon because there's already a page there.

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 A-lang-item Area: Language items
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants