Merge pull request #791 from rust-lang/inline-is-a-hint

Emphasize that `#[inline]` in all shapes is a hint.
rust-lang · Apr 11, 2020 · c2acacf · c2acacf
2 parents dbd58a1 + 1e92646
commit c2acacf
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/src/attributes/codegen.md b/src/attributes/codegen.md
@@ -25,12 +25,15 @@ function where it is defined.
 
 There are three ways to use the inline attribute:
 
-* `#[inline]` suggests performing an inline expansion.
-* `#[inline(always)]` suggests that an inline expansion should always be
+* `#[inline]` *suggests* performing an inline expansion.
+* `#[inline(always)]` *suggests* that an inline expansion should always be
   performed.
-* `#[inline(never)]` suggests that an inline expansion should never be
+* `#[inline(never)]` *suggests* that an inline expansion should never be
   performed.
 
+> ***Note***: `#[inline]` in every form is a hint, with no *requirements*
+> on the language to place a copy of the attributed function in the caller.
+
 ### The `cold` attribute
 
 The *`cold` [attribute]* suggests that the attributed function is unlikely to