Document every public API in pyathena/ and check docstrings with ruff - #919

Merged

laughingman7743 merged 13 commits into

chore/882-ruff-pydocstyle

Oct 3, 2026

Commits on Oct 3, 2026

Check docstrings in pyathena/ with ruff's pydocstyle rules

laughingman7743
and
claude
committed
a9d42e2
Keep other codes when removing a file's docstring ignores

laughingman7743
and
claude
committed
13e43c3
Say that ruff checks existing private docstrings, not only their format

laughingman7743
and
claude
committed
919d238
Document the model classes

laughingman7743
and
claude
committed
05a4fac
Document the result sets

laughingman7743
and
claude
committed
66b3ace
Document the S3 filesystem

laughingman7743
and
claude
committed
e6b4386
Document the SQLAlchemy dialects

laughingman7743
and
claude
committed
1191251
Document the connections, base cursors and shared modules

laughingman7743
and
claude
committed
f841ea6
Document the Arrow, pandas, Polars, S3FS and Spark cursors

laughingman7743
and
claude
committed
748a6ac
Check every docstring in pyathena/ without per-file exceptions

laughingman7743
and
claude
committed
24213c7
Say when on_start_query_execution and kill_on_interrupt apply

laughingman7743
and
claude
committed
8753ca8
Align the new docstrings with the current interrupt and cache behavior

laughingman7743
and
claude
committed
35fad82
Limit the chunking and description docstrings to where they apply

laughingman7743
and
claude
committed
6be315e