Skip to content
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.

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

docs(python/adbc_driver_manager): improve docstrings for set_options #965

Merged
merged 2 commits into from
Aug 14, 2023
Merged
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion python/adbc_driver_manager/adbc_driver_manager/_lib.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -570,6 +570,8 @@ cdef class AdbcDatabase(_AdbcHandle):
def set_options(self, **kwargs) -> None:
"""Set arbitrary key-value options.

Pass options as kwargs: ``set_options(**{"some.option": "value"})``.

Note, not all drivers support setting options after creation.

See Also
Expand Down Expand Up @@ -825,6 +827,8 @@ cdef class AdbcConnection(_AdbcHandle):
def set_options(self, **kwargs) -> None:
"""Set arbitrary key-value options.

Pass options as kwargs: ``set_options(**{"some.option": "value"})``.

Note, not all drivers support setting options after creation.

See Also
Expand Down Expand Up @@ -1090,7 +1094,9 @@ cdef class AdbcStatement(_AdbcHandle):
check_error(status, &c_error)

def set_options(self, **kwargs) -> None:
"""Set arbitrary key-value options.
"""Set arbitrary key-value options for this statement only.

Pass options as kwargs: ``set_options(**{"some.option": "value"})``.

See Also
--------
Expand Down
Loading