add some package-level comments

xoplog · Sep 26, 2022 · 5a5df4b · 5a5df4b
1 parent 0f5161f
commit 5a5df4b
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 0 deletions.
diff --git a/trace/trace.go b/trace/trace.go
@@ -1,3 +1,4 @@
+// trace is the data structures to describe trace_id and span_id
 package trace
 
 import (

diff --git a/xopbytes/bytelogger.go b/xopbytes/bytelogger.go
@@ -1,3 +1,4 @@
+// xopbytes wrapes io.Writer with additional methods useful for wrting logs
 package xopbytes
 
 import (

diff --git a/xopconst/standard.go b/xopconst/standard.go
@@ -1,3 +1,4 @@
+// xopconst provides pre-registed standard attributes for describing spans
 package xopconst
 
 import (

diff --git a/xopnum/levels.go → xopnum/level.go b/xopnum/levels.go → xopnum/level.go
@@ -1,3 +1,4 @@
+// xopnum provides constants used across the xop ecosystem
 package xopnum
 
 //go:generate enumer -type=Level -linecomment -json -sql

diff --git a/xopotel/models.go b/xopotel/models.go
@@ -1,3 +1,4 @@
+// xopotel provides interconnection between OpenTelemetry and xop
 package xopotel
 
 import (