itsscb/tracing
1
0
Fork 0
mirror of https://github.com/tokio-rs/tracing.git synced 2025-09-28 21:42:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove non-existing method in comments (#2894)

Browse Source 
In the documentation of the layer context span_scope method, the note
contained a reference to a `scope()` method, which was removed some time
ago. Also fixed a phrasing error above.

Fixes: #2890
This commit is contained in:
Gabriel Goller 2024-05-25 22:54:05 +02:00 committed by Hayden Stainsby
parent 5cebb65684
commit 329d8d3087
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
tracing-subscriber/src/layer/context.rs
View File

@ -316,11 +316,10 @@ where
/// Returns an iterator over the [stored data] for all the spans in the
/// current context, starting with the specified span and ending with the
/// root of the trace tree and ending with the current span.
/// root of the trace tree.
///
/// <pre class="ignore" style="white-space:normal;font:inherit;">
/// <strong>Note</strong>: Compared to <a href="#method.scope"><code>scope</code></a> this
/// returns the spans in reverse order (from leaf to root). Use
/// <strong>Note</strong>: This returns the spans in reverse order (from leaf to root). Use
/// <a href="../registry/struct.Scope.html#method.from_root"><code>Scope::from_root</code></a>
/// in case root-to-leaf ordering is desired.
/// </pre>