Skip to content

Revise example usage section headings - #22909

Merged
alamb merged 3 commits into
apache:mainfrom
Tchoupinax:patch-1
Aug 20, 2026
Merged

Revise example usage section headings#22909
alamb merged 3 commits into
apache:mainfrom
Tchoupinax:patch-1

Conversation

@Tchoupinax

Copy link
Copy Markdown
Contributor

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 2 or #2 to be less confusing IMO.

What do you think?

Thanks for your work!

Updated section headings to include '(example 2)' for clarity.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 11, 2026

@nuno-faria nuno-faria left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@github-actions

Copy link
Copy Markdown

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.

@github-actions github-actions Bot added the Stale PR has not had any activity for some time label Aug 15, 2026
Tchoupinax and others added 2 commits August 19, 2026 13:55
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>
@Tchoupinax

Copy link
Copy Markdown
Contributor Author

Thanks @nuno-faria — applied your suggestions:

  • Converted the SQL and DataFrame examples under Identifiers and Capitalization to list items instead of extra sections
  • Mentioned that this behavior can be disabled with datafusion.sql_parser.enable_ident_normalization = false, with a link to the configuration settings page

@Tchoupinax

Copy link
Copy Markdown
Contributor Author

production on the left, branch on the right

image

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.24%. Comparing base (c429919) to head (aed9c28).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions github-actions Bot removed the Stale PR has not had any activity for some time label Aug 20, 2026

@nuno-faria nuno-faria left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Tchoupinax.

@alamb
alamb added this pull request to the merge queue Aug 20, 2026
@alamb

alamb commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

🚀

Merged via the queue into apache:main with commit 93834e1 Aug 20, 2026
62 of 63 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants