Skip to content

Commit 42f00ee

Browse files
committed
Fix a bunch of rstcheck warnings
1 parent b232b9a commit 42f00ee

File tree

8 files changed

+17
-17
lines changed

8 files changed

+17
-17
lines changed

_template/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
OpenTelemetry <REPLACE ME> Instrumentation
2-
===========================
2+
==========================================
33

44
|pypi|
55

@@ -20,5 +20,5 @@ Installation
2020
References
2121
----------
2222

23-
* `OpenTelemetry <REPLACE ME>/ Tracing <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/<REPLACE ME>/<REPLACE ME>.html>`_
23+
* `OpenTelemetry REPLACE ME/ Tracing <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/REPLACE ME/REPLACE ME.html>`_
2424
* `OpenTelemetry Project <https://opentelemetry.io/>`_

instrumentation-genai/opentelemetry-instrumentation-google-genai/examples/manual/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
OpenTelemetry Google GenAI SDK Manual Instrumentation Example
2-
============================================
2+
=============================================================
33

44
This is an example of how to instrument Google GenAI SDK calls when configuring
55
OpenTelemetry SDK and Instrumentations manually.

instrumentation-genai/opentelemetry-instrumentation-google-genai/examples/zero-code/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
OpenTelemetry Google GenAI SDK Manual Instrumentation Example
2-
============================================
2+
=============================================================
33

44
This is an example of how to instrument Google GenAI SDK calls with zero code changes,
55
using `opentelemetry-instrument`.

instrumentation-genai/opentelemetry-instrumentation-langchain/examples/manual/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
OpenTelemetry Langcahin Instrumentation Example
2-
============================================
2+
===============================================
33

44
This is an example of how to instrument Langchain when configuring OpenTelemetry SDK and instrumentations manually.
55

6-
When :code:`main.py <main.py>`_ is run, it exports traces to an OTLP-compatible endpoint.
6+
When `main.py <main.py>`_ is run, it exports traces to an OTLP-compatible endpoint.
77
Traces include details such as the span name and other attributes.
88

9-
Note: :code:`.env <.env>`_ file configures additional environment variables:
9+
Note: `.env <.env>`_ file configures additional environment variables:
1010
- :code:`OTEL_LOGS_EXPORTER=otlp` to specify exporter type.
1111
- :code:`OPENAI_API_KEY` open AI key for accessing the OpenAI API.
1212
- :code:`OTEL_EXPORTER_OTLP_ENDPOINT` to specify the endpoint for exporting traces (default is http://localhost:4317).
1313

1414
Setup
1515
-----
1616

17-
Minimally, update the :code:`.env <.env>`_ file with your :code:`OPENAI_API_KEY`.
17+
Minimally, update the `.env <.env>`_ file with your :code:`OPENAI_API_KEY`.
1818
An OTLP compatible endpoint should be listening for traces http://localhost:4317.
1919
If not, update :code:`OTEL_EXPORTER_OTLP_ENDPOINT` as well.
2020

instrumentation-genai/opentelemetry-instrumentation-langchain/examples/zero-code/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
OpenTelemetry Langchain Zero-Code Instrumentation Example
2-
======================================================
2+
=========================================================
33

44
This is an example of how to instrument Langchain with zero code changes,
55
using `opentelemetry-instrument`.
66

7-
When :code:`main.py <main.py>`_ is run, it exports traces to an OTLP-compatible endpoint.
7+
When `main.py <main.py>`_ is run, it exports traces to an OTLP-compatible endpoint.
88
Traces include details such as the span name and other attributes.
99

10-
Note: :code:`.env <.env>`_ file configures additional environment variables:
10+
Note: `.env <.env>`_ file configures additional environment variables:
1111
- :code:`OTEL_LOGS_EXPORTER=otlp` to specify exporter type.
1212
- :code:`OPENAI_API_KEY` open AI key for accessing the OpenAI API.
1313
- :code:`OTEL_EXPORTER_OTLP_ENDPOINT` to specify the endpoint for exporting traces (default is http://localhost:4317).
1414

1515
Setup
1616
-----
1717

18-
Minimally, update the :code:`.env <.env>`_ file with your :code:`OPENAI_API_KEY`.
18+
Minimally, update the `.env <.env>`_ file with your :code:`OPENAI_API_KEY`.
1919
An OTLP compatible endpoint should be listening for traces http://localhost:4317.
2020
If not, update :code:`OTEL_EXPORTER_OTLP_ENDPOINT` as well.
2121

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/manual/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
OpenTelemetry VertexAI Instrumentation Example
2-
============================================
2+
==============================================
33

44
This is an example of how to instrument VertexAI calls when configuring OpenTelemetry SDK and Instrumentations manually.
55

@@ -12,8 +12,8 @@ your VertexAI requests.
1212
Note: `.env <.env>`_ file configures additional environment variables:
1313

1414
- `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true` configures
15-
VertexAI instrumentation to capture prompt and completion contents on
16-
events.
15+
VertexAI instrumentation to capture prompt and completion contents on
16+
events.
1717

1818
Setup
1919
-----

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/zero-code/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
OpenTelemetry VertexAI Instrumentation Example
2-
============================================
2+
==============================================
33

44
This is an example of how to instrument VertexAI calls with zero code changes,
55
using `opentelemetry-instrument`.

instrumentation/opentelemetry-instrumentation-urllib/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The hooks can be configured as follows:
3737
3838
# `request_obj` is an instance of urllib.request.Request
3939
# `response` is an instance of http.client.HTTPResponse
40-
def response_hook(span, request_obj, response)
40+
def response_hook(span, request_obj, response):
4141
pass
4242
4343
URLLibInstrumentor().instrument(

0 commit comments

Comments
 (0)