Skip to content

Commit 7081a0d

Browse files
committed
Update stability documentation, mention issue = "none"
1 parent b37ec78 commit 7081a0d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/stability.md

+5
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ attribute explicitly marks an item as unstable. Items that are marked as
1414
the crate, even on a nightly compiler. This restriction only applies across
1515
crate boundaries, unstable items may be used within the crate they are defined.
1616

17+
The `issue` field specifies the associated GitHub [issue number]. This field is
18+
required and all unstable features should have an associated tracking issue. In
19+
rare cases where there is no sensible value `issue = "none"` is used.
20+
1721
The `unstable` attribute infects all sub-items, where the attribute doesn't
1822
have to be reapplied. So if you apply this to a module, all items in the module
1923
will be unstable.
@@ -33,6 +37,7 @@ future-incompatible deny-by-default lint instead of a hard error. This is used
3337
by the `bench` attribute which was accidentally accepted in the past. This
3438
prevents breaking dependencies by leveraging Cargo's lint capping.
3539

40+
[issue number]: https://github.com/rust-lang/rust/issues
3641
[rustc bug]: https://github.com/rust-lang/rust/issues/15702
3742

3843
## stable

0 commit comments

Comments
 (0)