From 5a5df4befb7f40a9fbf69cdb8cb85e590489f368 Mon Sep 17 00:00:00 2001
From: David Muir Sharnoff <muir@idiom.org>
Date: Sun, 25 Sep 2022 19:02:08 -0700
Subject: [PATCH] add some package-level comments

---
 trace/trace.go                 | 1 +
 xopbytes/bytelogger.go         | 1 +
 xopconst/standard.go           | 1 +
 xopnum/{levels.go => level.go} | 1 +
 xopotel/models.go              | 1 +
 5 files changed, 5 insertions(+)
 rename xopnum/{levels.go => level.go} (91%)

diff --git a/trace/trace.go b/trace/trace.go
index 0fdbb071..e88ec26a 100644
--- 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
index c9dba4ce..01bcd4c6 100644
--- 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
index 447fb152..28854ea1 100644
--- 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 b/xopnum/level.go
similarity index 91%
rename from xopnum/levels.go
rename to xopnum/level.go
index c750a017..775e31f6 100644
--- a/xopnum/levels.go
+++ b/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
index 0aed3dfe..a9e2ce54 100644
--- a/xopotel/models.go
+++ b/xopotel/models.go
@@ -1,3 +1,4 @@
+// xopotel provides interconnection between OpenTelemetry and xop
 package xopotel
 
 import (