advitrocks9 opened a new pull request, #24645:
URL: https://github.com/apache/datafusion/pull/24645
## Which issue does this PR close?
- Part of #24209, box 1.
## Rationale for this change
The SQL example tables live inside `sql_example` literals and nothing
measures them. `print_functions_docs` copies each one onto the page verbatim,
so a table that doesn't line up in the source doesn't line up on the website.
`config-docs-check` only proves the page matches the literal, not that either
is well formed. Before #24596 there were 32 of these across 24 files.
## What changes are included in this PR?
A test that walks the same four registries `print_functions_docs` builds the
pages from, finds the ASCII tables in each `sql_example`, and checks every line
of a table is the same display width and every cell is padded as `| value |`.
It also rejects a markdown separator row inside an arrow table, since `regr`'s
four were all the correct width and a width check alone misses them.
A failure names the function and prints the table with its widths:
```
first_value, table at line 3 of the example:
49 +-----------------------------------------------+
49 | first_value(column_name ORDER BY other_column)| <- cell is not
padded as `| value |`
49 +-----------------------------------------------+
```
It sits in `datafusion/core/tests/` rather than `ci/scripts/` so it rides
`cargo test (amd64)`, already a required check, and can read
`Documentation::sql_example` directly instead of scraping the source. Width
comes from `unicode-width`, the same crate `comfy-table` measures with, at the
version already in `Cargo.lock`.
Two limits. A table ends when a line stops starting with `+` or `|`, so two
tables printed back to back with nothing between them would read as one.
Nothing in the tree does that. And the separator rule wants every cell to be
three or more of `-`, `:` and space, so a value that is literally `---` would
read as a rule.
## Are these changes tested?
It passes on main, so the evidence is the ablation. Reverting the sweep for
`arrow_field`, the example the issue links:
```
arrow_field, table at line 3 of the example:
63 +-------------------------------------------------------------+
63 | arrow_field(Int64(1)) |
63 +-------------------------------------------------------------+
64 | {name: lit, data_type: Int64, nullable: false, metadata: {}} |
63 +-------------------------------------------------------------+
```
Against the tree before #24596 it reports all 32. Four unit cases pin the
rules one at a time: a wide-character table that must pass, a short row, an
unpadded cell, and a separator row.
## Are there any user-facing changes?
No.
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
