Revise example usage section headings - #22909
Conversation
Updated section headings to include '(example 2)' for clarity.
nuno-faria
left a comment
There was a problem hiding this comment.
Thanks for you contribution @Tchoupinax. I agree that these are confusing. Since they are used to demonstrate the case behavior of the previous section, I think we can even convert them to items instead of sections, like so:
## Identifiers and Capitalization
...
- Using the SQL API:
...
- Using the DataFrame API:
...
Also, I think we should mention that this behavior can be disabled by setting the datafusion.sql_parser.enable_ident_normalization config to false.
|
Thank you for your contribution. Unfortunately, this pull request is stale because it has been open 60 days with no activity. Please remove the stale label or comment or this will be closed in 7 days. |
Convert the SQL and DataFrame examples to list items and mention datafusion.sql_parser.enable_ident_normalization, per review feedback. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Thanks @nuno-faria — applied your suggestions:
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #22909 +/- ##
==========================================
- Coverage 81.24% 81.24% -0.01%
==========================================
Files 1113 1113
Lines 392744 392744
Branches 392744 392744
==========================================
- Hits 319090 319078 -12
- Misses 54900 54907 +7
- Partials 18754 18759 +5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
🚀 |

Hello,
Just reading the documentation and was confused by given example. They are pretty similar. I was even thinking about merging them and only keep one example with operator and one with SQL.
At least, example title should be renamed with
example 2or#2to be less confusing IMO.What do you think?
Thanks for your work!