Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken RST docs #3062

Merged
merged 3 commits into from
Dec 5, 2024
+7 −7
Merged

Fix broken RST docs #3062

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7536c02
Fix doc formatting issues
buger Dec 3, 2024
f4538f7
Merge branch 'main' into main
emdneto Dec 3, 2024
035930f
Merge branch 'main' into main
emdneto Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions ...telemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/aiokafka/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
Usage
-----
..code:: python
.. code:: python
from opentelemetry.instrumentation.aiokafka import AIOKafkaInstrumentor
from aiokafka import AIOKafkaProducer, AIOKafkaConsumer
Expand All @@ -45,7 +45,8 @@ def async_produce_hook(span: Span, args, kwargs)
def async_consume_hook(span: Span, record: kafka.record.ABCRecord, args, kwargs)
for example:
emdneto marked this conversation as resolved.
Show resolved Hide resolved
.. code: python
.. code:: python
from opentelemetry.instrumentation.kafka import AIOKafkaInstrumentor
from aiokafka import AIOKafkaProducer, AIOKafkaConsumer
Expand Down
4 changes: 1 addition & 3 deletions ...rumentation-confluent-kafka/src/opentelemetry/instrumentation/confluent_kafka/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
Usage
-----

.. code-block:: python
.. code:: python

from opentelemetry.instrumentation.confluent_kafka import ConfluentKafkaInstrumentor
from confluent_kafka import Producer, Consumer
Expand Down Expand Up @@ -54,7 +54,6 @@ def basic_consume_loop(consumer, topics):
consumer.close()

basic_consume_loop(consumer, "my-topic")
---

The _instrument method accepts the following keyword args:
emdneto marked this conversation as resolved.
Show resolved Hide resolved
tracer_provider (TracerProvider) - an optional tracer provider
Expand Down Expand Up @@ -95,7 +94,6 @@ def instrument_consumer(consumer: Consumer, tracer_provider=None)
p.produce('my-topic',b'raw_bytes')
msg = c.poll()

___
"""

from typing import Collection
Expand Down
5 changes: 3 additions & 2 deletions ...elemetry-instrumentation-kafka-python/src/opentelemetry/instrumentation/kafka/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
Usage
-----

..code:: python
.. code:: python

from opentelemetry.instrumentation.kafka import KafkaInstrumentor
from kafka import KafkaProducer, KafkaConsumer
Expand All @@ -45,7 +45,8 @@ def produce_hook(span: Span, args, kwargs)
def consume_hook(span: Span, record: kafka.record.ABCRecord, args, kwargs)
for example:
emdneto marked this conversation as resolved.
Show resolved Hide resolved

.. code: python
.. code:: python

from opentelemetry.instrumentation.kafka import KafkaInstrumentor
from kafka import KafkaProducer, KafkaConsumer

Expand Down
Loading