Skip to content

doc: fix commenter_options type #1926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 3, 2023
Merged

doc: fix commenter_options type #1926

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8023be
doc: fix `commenter_options` type
joaothallis Aug 31, 2023
279c61d
Merge branch 'main' into docs/fix-commenter-options-doc-type
shalevr Sep 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...metry-instrumentation-sqlalchemy/src/opentelemetry/instrumentation/sqlalchemy/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ def _instrument(self, **kwargs):
``tracer_provider``: a TracerProvider, defaults to global
``meter_provider``: a MeterProvider, defaults to global
``enable_commenter``: bool to enable sqlcommenter, defaults to False
``commenter_options``: dict of sqlcommenter config, defaults to None
``commenter_options``: dict of sqlcommenter config, defaults to {}

Returns:
An instrumented engine if passed in as an argument or list of instrumented engines, None otherwise.
Expand Down