Add link to yield_now

This commit is contained in:
Stefan Schindler 2018-02-16 10:30:31 +01:00
parent 5570cdcc9e
commit 3bf989f4c9

View file

@ -97,9 +97,10 @@ use fmt;
/// Save power or switch hyperthreads in a busy-wait spin-loop.
///
/// This function is deliberately more primitive than
/// `std::thread::yield_now` and does not directly yield to the
/// system's scheduler. In some cases it might be useful to use a
/// combination of both functions. Careful benchmarking is advised.
/// [`std::thread::yield_now`](../../thread/fn.yield_now.html) and
/// does not directly yield to the system's scheduler.
/// In some cases it might be useful to use a combination of both functions.
/// Careful benchmarking is advised.
///
/// On some platforms this function may not do anything at all.
#[inline]