Skip to content

chore(docs): Fix the rendering of an expression in docstring - #25379

Merged
martin-g merged 1 commit into
apache:mainfrom
martin-g:fix-rendering-of-rustdoc
Sep 17, 2026
Merged

martin-g merged 1 commit into
apache:mainfrom
martin-g:fix-rendering-of-rustdoc

Conversation

@martin-g

Copy link
Copy Markdown
Member

Which issue does this PR close?

Closes N/A.

Rationale for this change

https://docs.rs/datafusion/latest/datafusion/catalog/trait.Session.html#tymethod.create_physical_expr renders:

Note: The expression is not simplified or otherwise optimized: `a = 1

* 2will not be simplified toa = 3` as this
image

What changes are included in this PR?

Keep the expression on one line.

image

What is the testing strategy for this PR?

Build the docs and verify that it renders well.

Are there any user-facing changes?

No.

https://docs.rs/datafusion/latest/datafusion/catalog/trait.Session.html#tymethod.create_physical_expr
renders:
```
Note: The expression is not simplified or otherwise optimized: `a = 1

* 2will not be simplified toa = 3` as this
```
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.93%. Comparing base (606ae0f) to head (b935903).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #25379      +/-   ##
==========================================
- Coverage   81.94%   81.93%   -0.02%     
==========================================
  Files        1135     1136       +1     
  Lines      428278   428677     +399     
  Branches   428278   428677     +399     
==========================================
+ Hits       350952   351230     +278     
- Misses      56369    56433      +64     
- Partials    20957    21014      +57     

☔ 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.

@martin-g
martin-g added this pull request to the merge queue Sep 17, 2026
@martin-g

Copy link
Copy Markdown
Member Author

Thank you for the review, @nuno-faria !

Merged via the queue into apache:main with commit 0342332 Sep 17, 2026
41 checks passed
@martin-g
martin-g deleted the fix-rendering-of-rustdoc branch September 17, 2026 04:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants