Skip to content

Conversation

@alamb
Copy link
Contributor

@alamb alamb commented Nov 25, 2025

Which issue does this PR close?

Rationale for this change

@cj-zhukov has been consolidating the examples, but that also means that the links to the examples are now out of date

What changes are included in this PR?

Update links (I used openai codex, with the prompt below) and reviewed the results

Prompt

We have moved the examples around in datafusion-examples/

  There are some links in doc comments such as in `datafusion/src/lib.rs`:

  [`expr_api`.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/
  examples/expr_api.rs

  This example has been moved to ./datafusion-examples/examples/query_planning/
  expr_api.rs

  Please look for all other links to datafusion-examples and update them if necessary to
  point at the new path.

Are these changes tested?

By CI

Are there any user-facing changes?

Fixed docs

@alamb alamb marked this pull request as ready for review November 25, 2025 15:00
Copy link
Contributor

@Jefffrey Jefffrey left a comment

Choose a reason for hiding this comment

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

Oh I just ran into this when looking up some documentation, nice timing 😄

@alamb alamb added the documentation Improvements or additions to documentation label Nov 25, 2025
@alamb alamb changed the title Fix links to doc examples Update links in documentation to point at new example locations Nov 25, 2025
@alamb
Copy link
Contributor Author

alamb commented Nov 25, 2025

I don't think this is a controversial change so I am just going to merge it in now. I am happy to make any changes if something comes up afterwards

@alamb
Copy link
Contributor Author

alamb commented Nov 25, 2025

Thanks @Jefffrey and @cj-zhukov

@alamb alamb added this pull request to the merge queue Nov 25, 2025
Merged via the queue into apache:main with commit 838e1de Nov 25, 2025
33 of 34 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.

2 participants