Skip to content

Commit 837105c

Browse files
authored
sync async_capture_span docs with capture_span (#1668)
1 parent e01327b commit 837105c

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/api.asciidoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -469,13 +469,13 @@ def coffee_maker(strength):
469469
fresh_pots()
470470
----
471471

472-
* `name`: The name of the span
472+
* `name`: The name of the span. Defaults to the function name if used as a decorator.
473473
* `span_type`: (*optional*) The type of the span, usually in a dot-separated hierarchy of `type`, `subtype`, and `action`, e.g. `db.mysql.query`. Alternatively, type, subtype and action can be provided as three separate arguments, see `span_subtype` and `span_action`.
474474
* `skip_frames`: (*optional*) The number of stack frames to skip when collecting stack traces. Defaults to `0`.
475475
* `leaf`: (*optional*) if `True`, all spans nested bellow this span will be ignored. Defaults to `False`.
476476
* `labels`: (*optional*) a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`.
477477
* `span_subtype`: (*optional*) subtype of the span, e.g. name of the database. Defaults to `None`.
478-
* `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`
478+
* `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`.
479479
* `links`: (*optional*) A list of `TraceParent` objects to which this span is causally linked.
480480

481481

@@ -508,13 +508,14 @@ async def coffee_maker(strength):
508508
fresh_pots()
509509
----
510510

511-
* `name`: The name of the span
512-
* `span_type`: The type of the span, usually in a dot-separated hierarchy of `type`, `subtype`, and `action`, e.g. `db.mysql.query`. Alternatively, type, subtype and action can be provided as three separate arguments, see `span_subtype` and `span_action`.
513-
* `skip_frames`: The number of stack frames to skip when collecting stack traces. Defaults to `0`.
514-
* `leaf`: if `True`, all spans nested bellow this span will be ignored. Defaults to `False`.
515-
* `labels`: a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`.
516-
* `span_subtype`: subtype of the span, e.g. name of the database. Defaults to `None`.
517-
* `span_action`: action of the span, e.g. `query`. Defaults to `None`
511+
* `name`: The name of the span. Defaults to the function name if used as a decorator.
512+
* `span_type`: (*optional*) The type of the span, usually in a dot-separated hierarchy of `type`, `subtype`, and `action`, e.g. `db.mysql.query`. Alternatively, type, subtype and action can be provided as three separate arguments, see `span_subtype` and `span_action`.
513+
* `skip_frames`: (*optional*) The number of stack frames to skip when collecting stack traces. Defaults to `0`.
514+
* `leaf`: (*optional*) if `True`, all spans nested bellow this span will be ignored. Defaults to `False`.
515+
* `labels`: (*optional*) a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`.
516+
* `span_subtype`: (*optional*) subtype of the span, e.g. name of the database. Defaults to `None`.
517+
* `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`.
518+
* `links`: (*optional*) A list of `TraceParent` objects to which this span is causally linked.
518519

519520
NOTE: `asyncio` is only supported for Python 3.7+.
520521

0 commit comments

Comments
 (0)