chore: add pyment config (#3648)

* chore: add pyment

* pyment config

* add docs to tracing

* fix strings

* Update pyment.conf

Co-authored-by: Xander Song <[email protected]>

---------

Co-authored-by: Xander Song <[email protected]>

Author: mikeldking

cspell.json

@@ -36,6 +36,7 @@
         "OTLP",
         "postprocessors",
         "pydantic",
+        "pyment",
         "Quantile",
         "quickstart",
         "referer",

pyment.conf

@@ -0,0 +1,6 @@
+first_line = false
+quotes = """
+output_style = google
+input_style = auto
+init2class = false
+indent = 4

pyproject.toml

@@ -206,6 +206,7 @@ dependencies = [
 [tool.hatch.envs.docs]
 detached = true
 dependencies = [
+  "pyment",
   "interrogate",
 ]
 

src/phoenix/datasets/tracing.py

@@ -12,12 +12,22 @@
 
 
 class SpanModifier:
+    """
+    A class that modifies spans with the specified resource attributes.
+    """
+
     __slots__ = ("_resource",)
 
     def __init__(self, resource: Resource) -> None:
         self._resource = resource
 
     def modify_resource(self, span: ReadableSpan) -> None:
+        """
+        Takes a span and merges in the resource attributes specified in the constructor.
+
+        Args:
+          span: ReadableSpan: the span to modify
+        """
         if (ctx := span._context) is None or ctx.span_id == INVALID_TRACE_ID:
             return
         span._resource = span._resource.merge(self._resource)
@@ -59,6 +69,15 @@ def _monkey_patch_span_init() -> Iterator[None]:
 
 @contextmanager
 def capture_spans(resource: Resource) -> Iterator[SpanModifier]:
+    """
+    A context manager that captures spans and modifies them with the specified resources.
+
+    Args:
+      resource: Resource: The resource to merge into the spans created within the context.
+
+    Returns:
+        modifier: Iterator[SpanModifier]: The span modifier that is active within the context.
+    """
     modifier = SpanModifier(resource)
     with _monkey_patch_span_init():
         token = _ACTIVE_MODIFIER.set(modifier)