From 6d563bfd91771ef6cea81122c56a8b39877e677b Mon Sep 17 00:00:00 2001
From: Tony Garnock-Jones <tonyg@leastfixedpoint.com>
Date: Wed, 11 Aug 2021 18:03:50 -0400
Subject: [PATCH] Document name macro

---
 src/actor.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/actor.rs b/src/actor.rs
index 63d1385..45653ba 100644
--- a/src/actor.rs
+++ b/src/actor.rs
@@ -916,6 +916,12 @@ where
     }
 }
 
+/// A convenient Syndicate-enhanced variation on
+/// [`tracing::info_span`].
+///
+/// Includes fields `actor_id`, `task_id` and `oid`, so that they show
+/// up in those circumstances where they happen to be defined as part
+/// of the operation of the [`crate::actor`] module.
 #[macro_export]
 macro_rules! name {
     () => {tracing::info_span!(actor_id = tracing::field::Empty,