Skip to content

Commit 51dde66

Browse files
authored
Fixup docs rendering in pymssql and pymongo (#4007)
* opentelemetry-instrumentation-pymongo: fix rendering of API docs While at it make the list of instrumentor parameters readable. * opentelemetry-instrumentation-pymssql: fix rendering of API docs * Update __init__.py
1 parent e107432 commit 51dde66

File tree

2 files changed

+8
-14
lines changed
  • instrumentation
    • opentelemetry-instrumentation-pymongo/src/opentelemetry/instrumentation/pymongo
    • opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql

2 files changed

+8
-14
lines changed

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

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,15 @@
3636
---
3737
The `instrument` method accepts the following keyword args:
3838
39-
tracer_provider (TracerProvider) - an optional tracer provider
40-
request_hook (Callable) -
41-
a function with extra user-defined logic to be performed before querying mongodb
42-
this function signature is: def request_hook(span: Span, event: CommandStartedEvent) -> None
43-
response_hook (Callable) -
44-
a function with extra user-defined logic to be performed after the query returns with a successful response
45-
this function signature is: def response_hook(span: Span, event: CommandSucceededEvent) -> None
46-
failed_hook (Callable) -
47-
a function with extra user-defined logic to be performed after the query returns with a failed response
48-
this function signature is: def failed_hook(span: Span, event: CommandFailedEvent) -> None
49-
capture_statement (bool) - an optional value to enable capturing the database statement that is being executed
39+
* tracer_provider (``TracerProvider``) - an optional tracer provider
40+
* request_hook (``Callable[[Span, CommandStartedEvent], None]``) - a function with extra user-defined logic to be performed before querying mongodb
41+
* response_hook (``Callable[[Span, CommandSucceededEvent], None]``) - a function with extra user-defined logic to be performed after the query returns with a successful response
42+
* failed_hook (``Callable[[Span, CommandFailedEvent], None]``) - a function with extra user-defined logic to be performed after the query returns with a failed response
43+
* capture_statement (``bool``) - an optional value to enable capturing the database statement that is being executed
5044
5145
for example:
5246
53-
.. code: python
47+
.. code:: python
5448
5549
from opentelemetry.instrumentation.pymongo import PymongoInstrumentor
5650
from pymongo import MongoClient

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@
5555
---
5656
The `instrument` method accepts the following keyword args:
5757
58-
tracer_provider (TracerProvider) - an optional tracer provider
58+
* tracer_provider (``TracerProvider``) - an optional tracer provider
5959
6060
For example:
6161
62-
.. code: python
62+
.. code:: python
6363
6464
import pymssql
6565
from opentelemetry.instrumentation.pymssql import PyMSSQLInstrumentor

0 commit comments

Comments
 (0)