Update outdated comment about output capturing in print_to.

This commit is contained in:
Mara Bos
2022-09-01 11:20:08 +02:00
parent b32223fec1
commit a20318d94b

View File

@@ -986,10 +986,10 @@ pub fn set_output_capture(sink: Option<LocalStream>) -> Option<LocalStream> {
/// otherwise. `label` identifies the stream in a panic message. /// otherwise. `label` identifies the stream in a panic message.
/// ///
/// This function is used to print error messages, so it takes extra /// This function is used to print error messages, so it takes extra
/// care to avoid causing a panic when `local_s` is unusable. /// care to avoid causing a panic when `OUTPUT_CAPTURE` is unusable.
/// For instance, if the TLS key for the local stream is /// For instance, if the TLS key for output capturing is already destroyed, or
/// already destroyed, or if the local stream is locked by another /// if the local stream is in use by another thread, it will just fall back to
/// thread, it will just fall back to the global stream. /// the global stream.
/// ///
/// However, if the actual I/O causes an error, this function does panic. /// However, if the actual I/O causes an error, this function does panic.
fn print_to<T>(args: fmt::Arguments<'_>, global_s: fn() -> T, label: &str) fn print_to<T>(args: fmt::Arguments<'_>, global_s: fn() -> T, label: &str)