lidavidm commented on code in PR #3388:
URL: https://github.com/apache/arrow-adbc/pull/3388#discussion_r2317450855
##########
docs/source/python/driver_manager.rst:
##########
@@ -21,15 +21,11 @@
Driver Manager
==============
-The driver manager is a library that provides bindings to the ADBC C
-API. It delegates to dynamically-loaded drivers. This allows
-applications to use multiple drivers simultaneously, and decouple
-themselves from the specific driver.
+The ``adbc_driver_manager`` package provides a :term:`driver manager` interface
+for Python. The package provides two APIs:
-The Python driver manager provides both low-level bindings that are
-essentially the same as the C API. If PyArrow is installed, it also
-provides high-level bindings that implement the DBAPI_ (PEP 249)
-standard.
+1. Low-level bindings that are essentially the same as the :doc:`C API
<../format/specification>`.
+2. If PyArrow is installed, a DBAPI_ (PEP 249) compliant interface.
Review Comment:
```suggestion
2. If PyArrow or Polars is installed, a DBAPI_ (PEP 249) compliant interface.
```
##########
docs/source/glossary.rst:
##########
@@ -46,16 +46,24 @@ Glossary
protocol, but exposes the JDBC client API instead.
driver manager
- A library that helps manage multiple drivers for a given client API.
- For example, the JDBC driver manager can find a appropriate driver
- implementation for a database URI.
+ A library for loading and using :term:`drivers <driver>`. A :term:`driver
+ manager` implements the ADBC API and delegates to
+ dynamically-loaded drivers. It simplifies using multiple drivers in a
+ single application and makes it possible to use drivers written in any
+ language, regardless of the language the application is written in.
- The ADBC driver manager in each language is similar. In C/C++, it can
+ The :term:`driver manager` in each language is similar. In C/C++, it can
dynamically load drivers so that applications do not have to directly
link to them. (Since all drivers expose the same API, their symbols
would collide otherwise.) In Python, it loads drivers and provides
Python bindings on top.
+ driver manifest
+ A file (in TOML format) describing a :term:`driver`. This file's structure
+ is part of the ADBC :doc:`specification <format/specification>`. A
+ :term:`driver manager` can load a driver from a :term:`driver manifest`
Review Comment:
nit, but I don't think the term needs to link to itself :sweat_smile:
##########
docs/source/rust/driver_manager.rst:
##########
@@ -19,11 +19,10 @@
Driver Manager
==============
-The driver manager is a library that implements the ADBC API by delegating to
-dynamically-loaded drivers. This allows applications to load drivers at
-runtime, and use drivers that aren't necessarily written in Rust. It is
-currently part of the adbc_core package, though we plan to split it into its
-own package for users who don't want or need FFI.
+This document describes the installation and usage of the Rust :term:`driver
+manager`. The Rust :term:`driver manager` is currently part of the
``adbc_core``
+package, though we plan to split it into its own package for to keep the
+``adbc_core`` package smaller for users who don't want or need FFI.
Review Comment:
It's already been split out
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
