Document path stability of f64::abs
in no std crates
#139066
Labels
A-docs
Area: Documentation for any part of the project, including the compiler, standard library, and tools
A-stability
Area: `#[stable]`, `#[unstable]` etc.
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.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
I tried this code:
In Rust older than 1.84.
I expected to see this happen: successful compilation since
f64::abs
is documented to be available since Rust 1.0.Instead, this happened: compilation failure since
f64::abs
in no std programs wasn't stabilized until Rust 1.84. This isn't documented anywhere and I had to go issue diving on GitHub.@RalfJung said the keywords here are documenting path stability vs item stability.
#131304 (comment)
Opening this issue to explore how to document the limited availability of items in no std programs.
In the absence of compiler infrastructure for this, free form text in the prose of the doc comment for the
f64
primitive or itsabs
method would have solved this for me. Maybe in a# Caveats
section?The text was updated successfully, but these errors were encountered: