about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2024-08-22 16:40:33 +0200
committerOli Scherer <github35764891676564198441@oli-obk.de>2024-08-31 15:02:08 +0200
commitdcdf1b578ff037e1f6cdfb63e51452246ddbd367 (patch)
treec25e72a5c289b232b2cc0560df3aa1c27f5a21aa /src/doc/rustc-dev-guide
parent894ceda9574dd2a7a902b80ba462a568cbbb3b48 (diff)
downloadrust-dcdf1b578ff037e1f6cdfb63e51452246ddbd367.tar.gz
rust-dcdf1b578ff037e1f6cdfb63e51452246ddbd367.zip
clarify the role of rustc_const_unstable
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/stability.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/doc/rustc-dev-guide/src/stability.md b/src/doc/rustc-dev-guide/src/stability.md
index bf82d85172d..ac77ad3f1e3 100644
--- a/src/doc/rustc-dev-guide/src/stability.md
+++ b/src/doc/rustc-dev-guide/src/stability.md
@@ -49,11 +49,11 @@ marks an item as stabilized. Note that stable functions may use unstable things
 
 ## rustc_const_unstable
 
-The `#[rustc_const_unstable(feature = "foo", issue = "1234", reason = "lorem ipsum")]`
-has the same interface as the `unstable` attribute. It is used to mark
-`const fn` as having their constness be unstable. This allows you to make a
-function stable without stabilizing its constness or even just marking an existing
-stable function as `const fn` without instantly stabilizing the `const fn`ness.
+The `#[rustc_const_unstable(feature = "foo", issue = "1234", reason = "lorem
+ipsum")]` has the same interface as the `unstable` attribute. It is used to mark
+`const fn` as having their constness be unstable. Every `const fn` with
+stability attributes should carry either this attribute or
+`#[rustc_const_stable]` (see below).
 
 Furthermore this attribute is needed to mark an intrinsic as `const fn`, because
 there's no way to add `const` to functions in `extern` blocks for now.