Skip to content

Document path stability of f64::abs in no std crates #139066

Description

@lopopolo

I tried this code:

#![no_std]

pub fn xxx() {
    f64::abs(1.0);
}

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 its abs method would have solved this for me. Maybe in a # Caveats section?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsA-stabilityArea: `#[stable]`, `#[unstable]` etc.C-enhancementCategory: An issue proposing an enhancement or a PR with one.T-libsRelevant to the library team, which will review and decide on the PR/issue.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions