search

sagebind / stability

Rust API stability attributes for the rest of us.
MIT License
28 stars 6 forks source link

Add issue tracking #6

Closed blyxyas closed 1 year ago

blyxyas commented 1 year ago

This PR adds the issue field in the unstable attribute. This way, an unstable feature can be actively tracked by the user.

Very minor addition

Usage

/// This function does something really risky!
///
/// Don't use it yet!
#[stability::unstable(feature = "risky-function", issue = "#101")]
pub fn risky_function() {
    unimplemented!()
}

This will output:

This function does something really risky!

Don’t use it yet!

Availability

This API is marked as unstable and is only available when the unstable-risky-function crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

The tracking issue is: #101

loyd commented 1 year ago

2023-03-05_18-16-02

Tabs instead of spaces =) I think rustfmt should be added in CI.