docs: fixing doc references

Missing references in the documentation were causing issues with dependent class definitions.
open-telemetry · May 22, 2020 · 791c31b · 791c31b
1 parent fc9897f
commit 791c31b
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 5 deletions.
diff --git a/docs/api/trace.rst b/docs/api/trace.rst
@@ -8,8 +8,9 @@ Submodules
 
    trace.sampling
    trace.status
+   trace.span
 
 Module contents
 ---------------
 
-.. automodule:: opentelemetry.trace
+.. automodule:: opentelemetry.trace
diff --git a/docs/api/trace.span.rst b/docs/api/trace.span.rst
@@ -0,0 +1,7 @@
+opentelemetry.trace.span
+==========================
+
+.. automodule:: opentelemetry.trace.span
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/opentelemetry-api/src/opentelemetry/trace/__init__.py b/opentelemetry-api/src/opentelemetry/trace/__init__.py
@@ -289,7 +289,7 @@ def start_span(
         span in this tracer's context.
 
         By default the current span will be used as parent, but an explicit
-        parent can also be specified, either a `Span` or a `SpanContext`. If
+        parent can also be specified, either a `Span` or a `opentelemetry.trace.SpanContext`. If
         the specified value is `None`, the created span will be a root span.
 
         The span can be used as context manager. On exiting, the span will be

diff --git a/opentelemetry-api/src/opentelemetry/trace/span.py b/opentelemetry-api/src/opentelemetry/trace/span.py
@@ -27,7 +27,7 @@ def get_context(self) -> "SpanContext":
         used to create new child spans.
 
         Returns:
-            A :class:`.SpanContext` with a copy of this span's immutable state.
+            A :class:`opentelemetry.trace.SpanContext` with a copy of this span's immutable state.
         """
 
     @abc.abstractmethod
@@ -68,7 +68,7 @@ def add_lazy_event(
     def update_name(self, name: str) -> None:
         """Updates the `Span` name.
 
-        This will override the name provided via :func:`Tracer.start_span`.
+        This will override the name provided via :func:`opentelemetry.trace.Tracer.start_span`.
 
         Upon this update, any sampling behavior based on Span name will depend
         on the implementation.

diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py
@@ -240,7 +240,7 @@ class Span(trace_api.Span):
     Args:
         name: The name of the operation this span represents
         context: The immutable span context
-        parent: This span's parent's `SpanContext`, or
+        parent: This span's parent's `opentelemetry.trace.SpanContext`, or
             null if this is a root span
         sampler: The sampler used to create this span
         trace_config: TODO