Commit 28874fe
docs: resolve mkdocs build warnings and tighten public API surface
Bring the strict mkdocs build to zero actionable warnings.
Cross-reference fixes:
- Replace ~20 unqualified `[X][X]` refs with fully-qualified targets
(sort/sort_by, cube/rollup/grouping_sets, array_* aliases, register_*,
Volatility, Serde, Producer, max_rows, metrics, etc.).
- Fix typos: `Dataframe` -> `DataFrame`, `datafusion.Expr.to_bytes` ->
`datafusion.expr.Expr.to_bytes`.
- Drop links to non-Python symbols: `SessionState`, `CreateExternalTable`,
`multiprocessing.Pool`, `cloudpickle`; point the `ObjectStore`
reference at the module page; link `LogicalExtensionCodec` to
`with_logical_extension_codec`.
- Update relative link in `dataframe_formatter.md` for the subdirectory
move.
Public surface and reference page coverage:
- Add `__all__` to `context`, `dataframe`, `dataframe_formatter`, `io`,
`record_batch`, `user_defined`, `input/base`, `input/location` so the
public surface is explicit.
- Document the newly-declared public symbols on the corresponding
reference pages (Compression, Volatility, *Exportable Protocols,
ArrowStreamExportable, etc.).
- Update `object_store.md` to render the PyO3 class aliases via explicit
per-class directives (whole-module discovery skips re-assigned PyO3
bindings).
- Allow `__next__`/`__anext__` through the formatter filter on
`RecordBatchStream` so the iterator protocol is documented.
Docstring fixes:
- Convert overload-impl Args blocks (ScalarUDF.udf, AggregateUDF.udaf,
WindowUDF.udwf) to free-form prose: their actual signatures are
`*args, **kwargs`, which griffe was flagging.
- Fix Args continuation indent in the formatter, the `idx::` typo, and a
`with_extension` Args entry whose continuation lost its indent.
- Re-wrap doctring lines that pushed past the 88-column limit after the
cross-ref qualifications.
mkdocstrings config: add `docstring_options: warn_unknown_params: false`
so future overload-impl patterns don't trip the build.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 6c42adc commit 28874fe
23 files changed
Lines changed: 266 additions & 122 deletions
File tree
- docs/source
- reference/datafusion
- user-guide/common-operations
- python/datafusion
- input
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| 19 | + | |
| 20 | + | |
19 | 21 | | |
20 | 22 | | |
21 | 23 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
| 3 | + | |
| 4 | + | |
3 | 5 | | |
4 | 6 | | |
5 | 7 | | |
| |||
19 | 21 | | |
20 | 22 | | |
21 | 23 | | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
453 | 453 | | |
454 | 454 | | |
455 | 455 | | |
456 | | - | |
457 | | - | |
| 456 | + | |
| 457 | + | |
458 | 458 | | |
459 | 459 | | |
460 | 460 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
208 | 208 | | |
209 | 209 | | |
210 | 210 | | |
211 | | - | |
| 211 | + | |
212 | 212 | | |
213 | 213 | | |
214 | 214 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
71 | 75 | | |
72 | 76 | | |
73 | 77 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
239 | 239 | | |
240 | 240 | | |
241 | 241 | | |
242 | | - | |
| 242 | + | |
243 | 243 | | |
244 | 244 | | |
245 | 245 | | |
| |||
0 commit comments