Skip to content

Commit

Permalink
Fix doc formatting issues (open-telemetry#3062)
Browse files Browse the repository at this point in the history
Co-authored-by: Emídio Neto <[email protected]>
  • Loading branch information
buger and emdneto authored Dec 5, 2024
1 parent f393546 commit 6c92f38
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
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:
.. code: python
.. code:: python
from opentelemetry.instrumentation.kafka import AIOKafkaInstrumentor
from aiokafka import AIOKafkaProducer, AIOKafkaConsumer
Expand Down
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:
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
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:
.. code: python
.. code:: python
from opentelemetry.instrumentation.kafka import KafkaInstrumentor
from kafka import KafkaProducer, KafkaConsumer
Expand Down

0 comments on commit 6c92f38

Please sign in to comment.