From 5d2c60930fca1bd64e48feaca885932a76319516 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 22 Jul 2024 10:20:15 +0200 Subject: [PATCH] Fix otelzap docs (#5933) Currently the docs are not rendered because the doc comments are not properly formatted. --- bridges/otelzap/core.go | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/bridges/otelzap/core.go b/bridges/otelzap/core.go index 3da8f94a55c..594de3e3a6d 100644 --- a/bridges/otelzap/core.go +++ b/bridges/otelzap/core.go @@ -3,7 +3,7 @@ // Package otelzap provides a bridge between the [go.uber.org/zap] and // [OpenTelemetry]. - +// // # Record Conversion // // The [zapcore.Entry] and [zapcore.Field] are converted to OpenTelemetry [log.Record] in the following @@ -14,9 +14,8 @@ // - Level is transformed and set as the Severity. The SeverityText is also // set. // - Fields are transformed and set as the Attributes. -// - Field value of type `context.Context` is used as context when emitting log records. +// - Field value of type [context.Context] is used as context when emitting log records. // - For named loggers, LoggerName is used to access [log.Logger] from [log.LoggerProvider] - // // The Level is transformed to the OpenTelemetry Severity types in the following way. // @@ -31,7 +30,6 @@ // Fields are transformed based on their type into log attributes, or into a string value if there is no matching type. // // [OpenTelemetry]: https://opentelemetry.io/docs/concepts/signals/logs/ - package otelzap // import "go.opentelemetry.io/contrib/bridges/otelzap" import (