From e770d5270b36436dae52c18977029e418a010982 Mon Sep 17 00:00:00 2001
From: Stephan Dilly <dilly.stephan@gmail.com>
Date: Mon, 22 Nov 2021 21:28:20 +0100
Subject: [PATCH] doc comment

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

diff --git a/src/tracing.rs b/src/tracing.rs
index 12c3c9280e..6a1481b698 100644
--- a/src/tracing.rs
+++ b/src/tracing.rs
@@ -57,6 +57,12 @@ impl Binding for TraceLevel {
     }
 }
 
+/// Callback type used to pass tracing events to the subscriber.
+/// see `trace_set` to register a scubscriber.
+///
+/// Note:
+///     libgit2 might pass non-utf8 strings therefore we
+///     pass the message as a byte slice
 pub type TracingCb = fn(TraceLevel, &[u8]);
 
 static CALLBACK: AtomicUsize = AtomicUsize::new(0);