add docs to pre-commit, fix issues (#38)

Author: davidhewitt

.pre-commit-config.yaml

@@ -24,9 +24,9 @@ repos:
     types: [rust]
     language: system
     pass_filenames: false
-  - id: test
-    name: Test
-    entry: cargo test --all-features
+  - id: docs
+    name: Check docs
+    entry: env RUSTDOCFLAGS="-D warnings" cargo doc --no-deps
     types: [rust]
     language: system
     pass_filenames: false

src/exporters.rs

@@ -27,7 +27,7 @@ macro_rules! feature_required {
     }};
 }
 
-/// Build a [`SpanExporter`][opentelemetry_sdk::trace::SpanExporter] for passing to
+/// Build a [`SpanExporter`] for passing to
 /// [`with_additional_span_processor()`][crate::LogfireConfigBuilder::with_additional_span_processor].
 ///
 /// This uses `OTEL_EXPORTER_OTLP_PROTOCOL` and `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` environment
@@ -98,7 +98,7 @@ pub fn span_exporter(
     Ok(RemovePendingSpansExporter::new(span_exporter))
 }
 
-/// Build a [`PushMetricExporter`][opentelemetry_sdk::metrics::exporter::PushMetricExporter] for passing to
+/// Build a [`PushMetricExporter`] for passing to
 /// [`with_metrics_options()`][crate::LogfireConfigBuilder::with_metrics_options].
 ///
 /// This uses `OTEL_EXPORTER_OTLP_PROTOCOL` and `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` environment

src/macros/mod.rs

@@ -200,6 +200,8 @@ macro_rules! debug {
 /// // or
 /// logfire::info!("Log with x = {x}, y = {y}", y = "hello", foo.bar = 42);
 /// ```
+///
+/// [attributes]: https://opentelemetry.io/docs/concepts/signals/traces/#attributes
 #[macro_export]
 macro_rules! log {
     (parent: $parent:expr, $level:expr, $format:expr $(, $($path:ident).+ = $value:expr)* $(,)?) => {