Skip to content

Commit 6c92f38

Browse files
bugeremdneto
andauthored
Fix doc formatting issues (#3062)
Co-authored-by: Emídio Neto <[email protected]>
1 parent f393546 commit 6c92f38

File tree

3 files changed

+7
-7
lines changed
  • instrumentation
    • opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/aiokafka
    • opentelemetry-instrumentation-confluent-kafka/src/opentelemetry/instrumentation/confluent_kafka
    • opentelemetry-instrumentation-kafka-python/src/opentelemetry/instrumentation/kafka

3 files changed

+7
-7
lines changed

instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/aiokafka/__init__.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
Usage
1919
-----
2020
21-
..code:: python
21+
.. code:: python
2222
2323
from opentelemetry.instrumentation.aiokafka import AIOKafkaInstrumentor
2424
from aiokafka import AIOKafkaProducer, AIOKafkaConsumer
@@ -45,7 +45,8 @@ def async_produce_hook(span: Span, args, kwargs)
4545
def async_consume_hook(span: Span, record: kafka.record.ABCRecord, args, kwargs)
4646
for example:
4747
48-
.. code: python
48+
.. code:: python
49+
4950
from opentelemetry.instrumentation.kafka import AIOKafkaInstrumentor
5051
from aiokafka import AIOKafkaProducer, AIOKafkaConsumer
5152

instrumentation/opentelemetry-instrumentation-confluent-kafka/src/opentelemetry/instrumentation/confluent_kafka/__init__.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
Usage
1919
-----
2020
21-
.. code-block:: python
21+
.. code:: python
2222
2323
from opentelemetry.instrumentation.confluent_kafka import ConfluentKafkaInstrumentor
2424
from confluent_kafka import Producer, Consumer
@@ -54,7 +54,6 @@ def basic_consume_loop(consumer, topics):
5454
consumer.close()
5555
5656
basic_consume_loop(consumer, "my-topic")
57-
---
5857
5958
The _instrument method accepts the following keyword args:
6059
tracer_provider (TracerProvider) - an optional tracer provider
@@ -95,7 +94,6 @@ def instrument_consumer(consumer: Consumer, tracer_provider=None)
9594
p.produce('my-topic',b'raw_bytes')
9695
msg = c.poll()
9796
98-
___
9997
"""
10098

10199
from typing import Collection

instrumentation/opentelemetry-instrumentation-kafka-python/src/opentelemetry/instrumentation/kafka/__init__.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
Usage
1919
-----
2020
21-
..code:: python
21+
.. code:: python
2222
2323
from opentelemetry.instrumentation.kafka import KafkaInstrumentor
2424
from kafka import KafkaProducer, KafkaConsumer
@@ -45,7 +45,8 @@ def produce_hook(span: Span, args, kwargs)
4545
def consume_hook(span: Span, record: kafka.record.ABCRecord, args, kwargs)
4646
for example:
4747
48-
.. code: python
48+
.. code:: python
49+
4950
from opentelemetry.instrumentation.kafka import KafkaInstrumentor
5051
from kafka import KafkaProducer, KafkaConsumer
5152

0 commit comments

Comments
 (0)