itsscb/tracing
1
0
Fork 0
mirror of https://github.com/tokio-rs/tracing.git synced 2025-10-02 07:20:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

core: s/soft deprecated/deprecated (#524)

Browse Source 
The docs for `drop_span` incorrectly state that the method is
"soft-deprecated", when it's actually...normal deprecated. The RustDoc
says that "using this method won't cause a compilation warning", but
this is incorrect.

This branch updates the doc comment.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
This commit is contained in:
Eliza Weisman 2020-01-10 13:38:00 -08:00 committed by GitHub
parent 0baa2a8e26
commit 57b967528a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
tracing-core/src/subscriber.rs
View File

@ -320,10 +320,11 @@ pub trait Subscriber: 'static {
id.clone()
}
/// **This method is soft-deprecated.**
/// **This method is deprecated.**
///
/// Although using it won’t cause compilation warning, new code should
/// call or implement [`try_close`] instead.
/// Using `drop_span` may result in subscribers composed using
/// `tracing-subscriber` crate's `Layer` trait from observing close events.
/// Use [`try_close`] instead.
///
/// The default implementation of this function does nothing.
///