From 791c31b7732ebb8050957ae67b2213974c37078c Mon Sep 17 00:00:00 2001 From: Yusuke Tsutsumi Date: Thu, 21 May 2020 22:39:29 -0700 Subject: [PATCH] docs: fixing doc references Missing references in the documentation were causing issues with dependent class definitions. --- docs/api/trace.rst | 3 ++- docs/api/trace.span.rst | 7 +++++++ opentelemetry-api/src/opentelemetry/trace/__init__.py | 2 +- opentelemetry-api/src/opentelemetry/trace/span.py | 4 ++-- opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py | 2 +- 5 files changed, 13 insertions(+), 5 deletions(-) create mode 100644 docs/api/trace.span.rst diff --git a/docs/api/trace.rst b/docs/api/trace.rst index 00823aa0362..411e31023ec 100644 --- 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 \ No newline at end of file diff --git a/docs/api/trace.span.rst b/docs/api/trace.span.rst new file mode 100644 index 00000000000..e816928287f --- /dev/null +++ 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 index e66054ed577..52dc9bbae0a 100644 --- 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 index 5eae7f170c8..7f0f39d92a1 100644 --- 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 index 86e11205cc1..dde30031d53 100644 --- 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