# documentation **URL:** https://internals.rust-lang.org/c/documentation/14.md [Latest](https://internals.rust-lang.org/latest.md) · [Categories](https://internals.rust-lang.org/categories.md) --- ## [About the documentation category](https://internals.rust-lang.org/t/about-the-documentation-category/68)
**Author:** [@cmr](https://internals.rust-lang.org/u/cmr)\ **Replies:** 0\ **Last updated:** [July 12, 2014, 2:42am UTC](https://internals.rust-lang.org/t/about-the-documentation-category/68 "2014-07-12T02:42:34Z")
Discussion about the documentation, either the prose docs or the API docs. --- ## [Add citations for official Rust books](https://internals.rust-lang.org/t/add-citations-for-official-rust-books/24507)
**Author:** [@Evian-Zhang](https://internals.rust-lang.org/u/Evian-Zhang)\ **Replies:** 3\ **Last updated:** [August 9, 2026, 8:55pm UTC](https://internals.rust-lang.org/t/add-citations-for-official-rust-books/24507 "2026-08-09T20:55:41Z")
The official Rust books, including The Rust Programming Language, The Rustonomicon, etc., have been important sources for recent academic papers related to Rust (as shown in google scholar, TRPL has been cited over 800+)… --- ## [Verbose Documentation for the number types](https://internals.rust-lang.org/t/verbose-documentation-for-the-number-types/24496)
**Author:** [@efe-cKia00](https://internals.rust-lang.org/u/efe-cKia00)\ **Replies:** 5\ **Last updated:** [July 29, 2026, 1:48pm UTC](https://internals.rust-lang.org/t/verbose-documentation-for-the-number-types/24496 "2026-07-29T13:48:18Z")
It would be helpful to add a little more information about the number type(s) in the rust documentation. In the current documentation which is accessible via rust-analyzer, if I were to hover over the u16 type label it w… --- ## [Share how safety tags are combined with function grouping/navigation](https://internals.rust-lang.org/t/share-how-safety-tags-are-combined-with-function-grouping-navigation/23967)
**Author:** [@vague](https://internals.rust-lang.org/u/vague)\ **Replies:** 2\ **Last updated:** [February 3, 2026, 6:43am UTC](https://internals.rust-lang.org/t/share-how-safety-tags-are-combined-with-function-grouping-navigation/23967 "2026-02-03T06:43:43Z")
Safety tags are rendered as badges appended to the function names. Unsafe functions are in red. It's included as a core feature in the UI tool I recently developed for safety tags. May be more appropriate as a user f… --- ## [Example viewer on docs - self contained examples](https://internals.rust-lang.org/t/example-viewer-on-docs-self-contained-examples/23929)
**Author:** [@latot](https://internals.rust-lang.org/u/latot)\ **Replies:** 0\ **Last updated:** [January 15, 2026, 10:14pm UTC](https://internals.rust-lang.org/t/example-viewer-on-docs-self-contained-examples/23929 "2026-01-15T22:14:08Z")
Hi all! I addressed a issue which could fit more be a feature request to rust in cargo, to avoid copy/paste, pls first read this one, describe the feature request: I wanted to create a issue on the rust-lang/rust gith… --- ## [Pre-RFC: add LLM text version to rustdoc](https://internals.rust-lang.org/t/pre-rfc-add-llm-text-version-to-rustdoc/22090)
**Author:** [@Folyd](https://internals.rust-lang.org/u/Folyd)\ **Replies:** 15\ **Last updated:** [December 10, 2025, 6:53pm UTC](https://internals.rust-lang.org/t/pre-rfc-add-llm-text-version-to-rustdoc/22090 "2025-12-10T18:53:11Z")
Summary Add a new rustdoc output format that generates a simplified, AI-friendly version of the crate's public API surface. This format excludes private items and function implementations while preserving documentation, … --- ## [Pre-RFC: allow to merge inherent impl blocks in the HTML](https://internals.rust-lang.org/t/pre-rfc-allow-to-merge-inherent-impl-blocks-in-the-html/23622)
**Author:** [@Yarwin](https://internals.rust-lang.org/u/Yarwin)\ **Replies:** 4\ **Last updated:** [November 15, 2025, 11:53am UTC](https://internals.rust-lang.org/t/pre-rfc-allow-to-merge-inherent-impl-blocks-in-the-html/23622 "2025-11-15T11:53:11Z")
Summary Allow to merge various impl blocks in the HTML output Motivation There is only one usecase in mind – currently RustDoc generates separate impl docs for every impl block. Example: ▶ Screenshot Implementing this … --- ## ["This code is unsound" code block marker in rustdoc](https://internals.rust-lang.org/t/this-code-is-unsound-code-block-marker-in-rustdoc/23618)
**Author:** [@ais523](https://internals.rust-lang.org/u/ais523)\ **Replies:** 1\ **Last updated:** [October 13, 2025, 5:41am UTC](https://internals.rust-lang.org/t/this-code-is-unsound-code-block-marker-in-rustdoc/23618 "2025-10-13T05:41:48Z")
Currently, if you write a code block in documentation, it gets interpreted as a doctest unless you mark it as not being tested, in which case you get a "This example is not tested" indicator on it. Likewise, if you mark … --- ## [Releases.rs docs 1.90 have incorrect date](https://internals.rust-lang.org/t/releases-rs-docs-1-90-have-incorrect-date/23548)
**Author:** [@daniel-pfeiffer](https://internals.rust-lang.org/u/daniel-pfeiffer)\ **Replies:** 1\ **Last updated:** [September 19, 2025, 8:37am UTC](https://internals.rust-lang.org/t/releases-rs-docs-1-90-have-incorrect-date/23548 "2025-09-19T08:37:00Z")
This calls it 1.90.0 beta and says Unreleased, branched from master Will be stable on: 30 October, 2025 --- ## [Ctrl-click on symbols in docs.rs](https://internals.rust-lang.org/t/ctrl-click-on-symbols-in-docs-rs/23439)
**Author:** [@alrz](https://internals.rust-lang.org/u/alrz)\ **Replies:** 7\ **Last updated:** [August 22, 2025, 10:00pm UTC](https://internals.rust-lang.org/t/ctrl-click-on-symbols-in-docs-rs/23439 "2025-08-22T22:00:38Z")
I was looking for this coming from source.dot.net. It's a very useful feature where you can explore the source without cloning it locally, or as a workaround, using github.dev or github1s.com which works but it's only te… --- ## [Any() doc is ambiguous](https://internals.rust-lang.org/t/any-doc-is-ambiguous/23310)
**Author:** [@daniel-pfeiffer](https://internals.rust-lang.org/u/daniel-pfeiffer)\ **Replies:** 25\ **Last updated:** [August 7, 2025, 4:29pm UTC](https://internals.rust-lang.org/t/any-doc-is-ambiguous/23310 "2025-08-07T16:29:31Z")
I understood “any() is short-circuiting; in other words, it will stop processing” as saying it will stop checking. I was surprised that this also stops a preceding map() retroactively, skipping my intended side effects. … --- ## [\[Pre-RFC\] Markdown alerts for documentation](https://internals.rust-lang.org/t/pre-rfc-markdown-alerts-for-documentation/23086)
**Author:** [@Sanpi](https://internals.rust-lang.org/u/Sanpi)\ **Replies:** 3\ **Last updated:** [June 14, 2025, 7:18am UTC](https://internals.rust-lang.org/t/pre-rfc-markdown-alerts-for-documentation/23086 "2025-06-14T07:18:32Z")
Feature Name: doc\_gfm\_alerts Start Date: 2025-06-13 RFC PR: Rust Issue: Summary Adding github compatible markdown alerts to rust documenation. Motivation Uses a markdown like syntax instead of html; Adding more kind … --- ## [Rustc-dev-guide: 3199 commits rewritten?](https://internals.rust-lang.org/t/rustc-dev-guide-3199-commits-rewritten/22559)
**Author:** [@binarycat](https://internals.rust-lang.org/u/binarycat)\ **Replies:** 1\ **Last updated:** [March 14, 2025, 8:47pm UTC](https://internals.rust-lang.org/t/rustc-dev-guide-3199-commits-rewritten/22559 "2025-03-14T20:47:27Z")
I was about to add a section to rustc-dev-guide, when I noticed something peculiar: It's not just me, looking at other people's forks, you can see the same pattern, and doing some simple math we can see that all but 4… --- ## [Providing TeXInfo output for the documentations, and The Book](https://internals.rust-lang.org/t/providing-texinfo-output-for-the-documentations-and-the-book/22418)
**Author:** [@divyaranjan](https://internals.rust-lang.org/u/divyaranjan)\ **Replies:** 1\ **Last updated:** [February 20, 2025, 3:34pm UTC](https://internals.rust-lang.org/t/providing-texinfo-output-for-the-documentations-and-the-book/22418 "2025-02-20T15:34:29Z")
TeXInfo is a versatile way of providing package documentations, and is widely across free software projects. TeXInfo can be converted into HTML, or just read read in an info reader, as one that comes with GNU Emacs. It c… --- ## [Translation project of Rust documents](https://internals.rust-lang.org/t/translation-project-of-rust-documents/22281)
**Author:** [@dalance](https://internals.rust-lang.org/u/dalance)\ **Replies:** 6\ **Last updated:** [February 9, 2025, 1:15pm UTC](https://internals.rust-lang.org/t/translation-project-of-rust-documents/22281 "2025-02-09T13:15:25Z")
I previously proposed adding a subrepository for translating documentation to Rust, but it was closed due to lack of capacity to maintain it on an ongoing basis. So, my other idea is to set up a GitHub organization (e… --- ## ["nightly-rustc" docs are also generated for stable](https://internals.rust-lang.org/t/nightly-rustc-docs-are-also-generated-for-stable/21871)
**Author:** [@binarycat](https://internals.rust-lang.org/u/binarycat)\ **Replies:** 1\ **Last updated:** [November 16, 2024, 8:01am UTC](https://internals.rust-lang.org/t/nightly-rustc-docs-are-also-generated-for-stable/21871 "2024-11-16T08:01:29Z")
look at this url https://doc.rust-lang.org/stable/nightly-rustc/ why is it like that. i would reccomended just removing the "nightly-" prefix --- ## [Mistake in ptr::from\_ref() doc comment on temporary lifetime?](https://internals.rust-lang.org/t/mistake-in-ptr-from-ref-doc-comment-on-temporary-lifetime/21800)
**Author:** [@cdbennett](https://internals.rust-lang.org/u/cdbennett)\ **Replies:** 1\ **Last updated:** [November 1, 2024, 5:22pm UTC](https://internals.rust-lang.org/t/mistake-in-ptr-from-ref-doc-comment-on-temporary-lifetime/21800 "2024-11-01T17:22:48Z")
I think there is a mistake in the explanation related to temporary lifetime extension in the documentation for std::ptr::from\_ref(): Note that this has subtle interactions with the rules for lifetime extension of tempo… --- ## [Discussion: Mis-documentation of \`.append\` method in \`OpenOption\`](https://internals.rust-lang.org/t/discussion-mis-documentation-of-append-method-in-openoption/21737)
**Author:** [@Neutron3529](https://internals.rust-lang.org/u/Neutron3529)\ **Replies:** 4\ **Last updated:** [October 22, 2024, 4:03pm UTC](https://internals.rust-lang.org/t/discussion-mis-documentation-of-append-method-in-openoption/21737 "2024-10-22T16:03:24Z")
Currently, the doc said: /// This option, when true, means that writes will append to a file instead /// of overwriting previous contents. /// Note that setting \`.write(true).append(true)\` has the same effec… --- ## [Release note process question](https://internals.rust-lang.org/t/release-note-process-question/21726)
**Author:** [@mathstuf](https://internals.rust-lang.org/u/mathstuf)\ **Replies:** 2\ **Last updated:** [October 18, 2024, 4:49pm UTC](https://internals.rust-lang.org/t/release-note-process-question/21726 "2024-10-18T16:49:34Z")
Hi, I learned via an LWN comment that Rust now does release notes via issues and then the team writes them if there's no response. We used to do this for VTK and the no-response rate was through the roof. The number of … --- ## [Are \[env\] blocks documented anywhere?](https://internals.rust-lang.org/t/are-env-blocks-documented-anywhere/21657)
**Author:** [@garagedragon](https://internals.rust-lang.org/u/garagedragon)\ **Replies:** 2\ **Last updated:** [October 6, 2024, 5:33pm UTC](https://internals.rust-lang.org/t/are-env-blocks-documented-anywhere/21657 "2024-10-06T17:33:09Z")
While doing some digging, I discovered that it is possible for a crate to define environment variables in its subprocesses including its dependent crates, and apparently this has been stable for a number of years. Howev… --- ## [How to add documentation to stdlib?](https://internals.rust-lang.org/t/how-to-add-documentation-to-stdlib/21622)
**Author:** [@akrauze](https://internals.rust-lang.org/u/akrauze)\ **Replies:** 3\ **Last updated:** [September 28, 2024, 9:17pm UTC](https://internals.rust-lang.org/t/how-to-add-documentation-to-stdlib/21622 "2024-09-28T21:17:01Z")
Hi. I would like to expand documentation of keyword break (it mentions labelled blocs, but examples only show breaking from loops). How should I go about adding documentation to stdlib? Should I just open a PR? Should… --- ## [What the process of changing unsafe code restrictions?](https://internals.rust-lang.org/t/what-the-process-of-changing-unsafe-code-restrictions/21595)
**Author:** [@AngelicosPhosphoros](https://internals.rust-lang.org/u/AngelicosPhosphoros)\ **Replies:** 2\ **Last updated:** [September 25, 2024, 9:25pm UTC](https://internals.rust-lang.org/t/what-the-process-of-changing-unsafe-code-restrictions/21595 "2024-09-25T21:25:08Z")
I want to have panics allowed in inline assembly blocks in some cases. Simple example (which de facto works correctly): // I wrote this to inspect the code in IDA #\[inline(never)\] #\[no\_mangle\] fn wrapper\_for\_ida(arg: u… --- ## [Extra character in rust book](https://internals.rust-lang.org/t/extra-character-in-rust-book/21474)
**Author:** [@Avrimuskom](https://internals.rust-lang.org/u/Avrimuskom)\ **Replies:** 5\ **Last updated:** [September 9, 2024, 1:33pm UTC](https://internals.rust-lang.org/t/extra-character-in-rust-book/21474 "2024-09-09T13:33:18Z")
https://doc.rust-lang.org/book/ch04-01-what-is-ownership.html rustbook-en/src/ch04-01-what-is-ownership.md Extra symbol is { --- ## [Generating a documentation for tests](https://internals.rust-lang.org/t/generating-a-documentation-for-tests/21442)
**Author:** [@ifxfrancois](https://internals.rust-lang.org/u/ifxfrancois)\ **Replies:** 0\ **Last updated:** [August 27, 2024, 8:46am UTC](https://internals.rust-lang.org/t/generating-a-documentation-for-tests/21442 "2024-08-27T08:46:29Z")
During the development of embedded software, Quality or certifications teams need a quick overview of the tests of a project. Typical relevant information are what, how and why a test tests. This information can easily … --- ## [Object Safety is a terrible term](https://internals.rust-lang.org/t/object-safety-is-a-terrible-term/21025)
**Author:** [@kornel](https://internals.rust-lang.org/u/kornel)\ **Replies:** 40\ **Last updated:** [August 4, 2024, 3:19am UTC](https://internals.rust-lang.org/t/object-safety-is-a-terrible-term/21025 "2024-08-04T03:19:26Z")
edit: this has been fixed! Meeting proposal: rename "object safety" to "dyn compatibility" · Issue #286 · rust-lang/lang-team · GitHub The term "Object Safety" is like a "Guinea Pig" — not a pig, and not from Guinea. R… --- ## [It is not strictly true that "items from traits can only be used if the trait is in scope"](https://internals.rust-lang.org/t/it-is-not-strictly-true-that-items-from-traits-can-only-be-used-if-the-trait-is-in-scope/21242)
**Author:** [@binarycat](https://internals.rust-lang.org/u/binarycat)\ **Replies:** 5\ **Last updated:** [July 26, 2024, 12:48am UTC](https://internals.rust-lang.org/t/it-is-not-strictly-true-that-items-from-traits-can-only-be-used-if-the-trait-is-in-scope/21242 "2024-07-26T00:48:09Z")
take this simple program. use std::io; fn main() { \::write(&mut io::stdout(), b"hello").unwrap(); } this form is actually useful in niche situations, such as if you already have a differen… --- ## [Improve slice documentaion](https://internals.rust-lang.org/t/improve-slice-documentaion/21168)
**Author:** [@spencer3035](https://internals.rust-lang.org/u/spencer3035)\ **Replies:** 1\ **Last updated:** [July 12, 2024, 11:41pm UTC](https://internals.rust-lang.org/t/improve-slice-documentaion/21168 "2024-07-12T23:41:31Z")
I have been botherd multiple times that most examples are not complete in the slice documentation. I went ahead and made a fork with what I would consider more complete documentation. It has an explicit check for the pro… --- ## [Different notions of "Safety" in Rust terminology](https://internals.rust-lang.org/t/different-notions-of-safety-in-rust-terminology/21035)
**Author:** [@steffahn](https://internals.rust-lang.org/u/steffahn)\ **Replies:** 12\ **Last updated:** [June 16, 2024, 4:46pm UTC](https://internals.rust-lang.org/t/different-notions-of-safety-in-rust-terminology/21035 "2024-06-16T16:46:02Z")
This thread serves as a thread for side-discussions that started in another thread that aims to discuss how good or bad a term the term "object safety" is. This thread can hold the more in-depth exploration of other u… --- ## [Subtrait Section](https://internals.rust-lang.org/t/subtrait-section/20859)
**Author:** [@heurix](https://internals.rust-lang.org/u/heurix)\ **Replies:** 3\ **Last updated:** [May 31, 2024, 4:42pm UTC](https://internals.rust-lang.org/t/subtrait-section/20859 "2024-05-31T16:42:15Z")
Please can a Subtrait section be added to the documentation (where applicable) so that it’s possible to quickly navigate the subtraits? This balances with the Implementors section. Apologies if this has been asked befor… --- ## [Rustdoc: ability to exclude "prelude" modules from search](https://internals.rust-lang.org/t/rustdoc-ability-to-exclude-prelude-modules-from-search/20571)
**Author:** [@SkiFire13](https://internals.rust-lang.org/u/SkiFire13)\ **Replies:** 8\ **Last updated:** [April 2, 2024, 6:48am UTC](https://internals.rust-lang.org/t/rustdoc-ability-to-exclude-prelude-modules-from-search/20571 "2024-04-02T06:48:47Z")
In crates with prelude modules it often happens that searching for some item will yield multiple results, one for the actual item and one for its re-export in the prelude. This increases noise and makes it harder to find… [Next page](https://internals.rust-lang.org/c/documentation/14.md?page=1)