docs: fix conflicting status legend and inconsistent issue links in expressions.md#4574
Open
andygrove wants to merge 1 commit into
Open
docs: fix conflicting status legend and inconsistent issue links in expressions.md#4574andygrove wants to merge 1 commit into
andygrove wants to merge 1 commit into
Conversation
…xpressions.md The introduction described the⚠️ marker as "Supported (caveats)" whose divergent cases fall back to Spark by default and require allowIncompatible, which contradicts the status legend (and the actual⚠️ rows):⚠️ means "Incorrect by default", running natively and potentially returning wrong values. The intro is rewritten to match the legend, and the allowIncompatible opt-in is described separately as a property of certain ✅ expressions. Issue and pull request references in the Notes column were a mix of bare numbers (such as "tracking apache#4098") and full Markdown links. Since these docs render via Sphinx, where bare references do not autolink, all references are now full links.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
N/A
Rationale for this change
The
expressions.mdreference page had two inconsistencies:Conflicting definition of the⚠️ marker. The introduction described ⚠️ as "Supported (caveats)" whose divergent cases fall back to Spark by default and must be opted into with ⚠️ rows, ⚠️ as "Incorrect by default": Comet runs natively by default and can return results that differ from Spark. The two definitions contradicted each other. The "falls back by default + allowIncompatible opt-in" behavior actually applies to certain ✅ expressions (for example ⚠️ expressions.
allowIncompatible. The status legend (and the actualarray_sizeandtry_make_timestamp) definecast,array_except), not toInconsistent issue and pull request references. The Notes column mixed bare references (such as
tracking #4098and(#4288)) with full Markdown links. These docs render via Sphinx, where bare#NNNNreferences do not autolink, so the bare ones were not clickable.What changes are included in this PR?
allowIncompatibleopt-in separately as a property of certain ✅ expressions.[#NNNN](https://github.com/apache/datafusion-comet/issues/NNNN)) for consistency with the references that were already linked.prettierto realign the affected tables (the bulk of the line count change is column re-padding).How are these changes tested?
Documentation-only change.
prettier --check "**/*.md"passes, matching the CI formatting check.