Imported Upstream version 1.72.0

[platform/upstream/boost.git] / libs / outcome / doc / src / content / reference / macros / tryx.md

diff --git a/libs/outcome/doc/src/content/reference/macros/tryx.md b/libs/outcome/doc/src/content/reference/macros/tryx.md
index af1eca4..8d5f5c2 100644 (file)
--- a/libs/outcome/doc/src/content/reference/macros/tryx.md
+++ b/libs/outcome/doc/src/content/reference/macros/tryx.md
@@ -11,6 +11,8 @@ Evaluate an expression which results in a type matching the following customisat
 
 Default overloads for these customisation points are provided. See [the recipe for supporting foreign input to `BOOST_OUTCOME_TRY`]({{% relref "/recipes/foreign-try" %}}).
 
+Hints are given to the compiler that the expression will be successful. If you expect failure, you should use {{% api "BOOST_OUTCOME_TRYX_FAILURE_LIKELY(expr)" %}} instead.
+
 *Availability*: GCC and clang only. Use `#ifdef BOOST_OUTCOME_TRYX` to determine if available.
 
 *Overridable*: Not overridable.