From 3c4170f9310f1bedd7d7a7d08a210d2d566d9364 Mon Sep 17 00:00:00 2001 From: Benjamin Wohlwend Date: Fri, 14 Oct 2022 12:16:31 +0200 Subject: [PATCH] sync async_capture_span docs with capture_span --- docs/api.asciidoc | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/api.asciidoc b/docs/api.asciidoc index aa164f0cc..24f7e082c 100644 --- a/docs/api.asciidoc +++ b/docs/api.asciidoc @@ -469,13 +469,13 @@ def coffee_maker(strength): fresh_pots() ---- - * `name`: The name of the span + * `name`: The name of the span. Defaults to the function name if used as a decorator. * `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`. * `skip_frames`: (*optional*) The number of stack frames to skip when collecting stack traces. Defaults to `0`. * `leaf`: (*optional*) if `True`, all spans nested bellow this span will be ignored. Defaults to `False`. * `labels`: (*optional*) a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`. * `span_subtype`: (*optional*) subtype of the span, e.g. name of the database. Defaults to `None`. - * `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None` + * `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`. * `links`: (*optional*) A list of `TraceParent` objects to which this span is causally linked. @@ -508,13 +508,14 @@ async def coffee_maker(strength): fresh_pots() ---- - * `name`: The name of the span - * `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`. - * `skip_frames`: The number of stack frames to skip when collecting stack traces. Defaults to `0`. - * `leaf`: if `True`, all spans nested bellow this span will be ignored. Defaults to `False`. - * `labels`: a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`. - * `span_subtype`: subtype of the span, e.g. name of the database. Defaults to `None`. - * `span_action`: action of the span, e.g. `query`. Defaults to `None` + * `name`: The name of the span. Defaults to the function name if used as a decorator. + * `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`. + * `skip_frames`: (*optional*) The number of stack frames to skip when collecting stack traces. Defaults to `0`. + * `leaf`: (*optional*) if `True`, all spans nested bellow this span will be ignored. Defaults to `False`. + * `labels`: (*optional*) a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`. + * `span_subtype`: (*optional*) subtype of the span, e.g. name of the database. Defaults to `None`. + * `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`. + * `links`: (*optional*) A list of `TraceParent` objects to which this span is causally linked. NOTE: `asyncio` is only supported for Python 3.7+.