Skip to content

[Data] Fix broken code snippets in user guides#55519

Merged
bveeramani merged 9 commits intomasterfrom
fix-data-docs
Aug 20, 2025
Merged

[Data] Fix broken code snippets in user guides#55519
bveeramani merged 9 commits intomasterfrom
fix-data-docs

Conversation

@bveeramani
Copy link
Member

@bveeramani bveeramani commented Aug 12, 2025

Why are these changes needed?

In #51334, we discovered we weren't actually testing code snippets in our user guides. As a result, there are several broken code snippets in our guides.

This PR fixes some of those code snippets, and re-enables testing on the user guides.

Related issue number

Fixes #52536

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@bveeramani bveeramani requested review from a team as code owners August 12, 2025 06:19
@gemini-code-assist
Copy link
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@bveeramani bveeramani marked this pull request as draft August 12, 2025 06:19
Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
@bveeramani bveeramani changed the title [Data] Fix examples in some user guides [Data] Fix broken code snippets in user guides Aug 12, 2025
bveeramani and others added 5 commits August 12, 2025 00:37
Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
…to fix-data-docs

Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
@bveeramani bveeramani added the go add ONLY when ready to merge, run all tests label Aug 20, 2025
@bveeramani bveeramani marked this pull request as ready for review August 20, 2025 18:44
@bveeramani bveeramani enabled auto-merge (squash) August 20, 2025 18:58
@ray-gardener ray-gardener bot added docs An issue or change related to documentation data Ray Data-related issues labels Aug 20, 2025
Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

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

stamp

@bveeramani bveeramani merged commit 9671f67 into master Aug 20, 2025
7 checks passed
@bveeramani bveeramani deleted the fix-data-docs branch August 20, 2025 22:23
ljstrnadiii pushed a commit to ljstrnadiii/ray that referenced this pull request Aug 21, 2025
In ray-project#51334, we discovered we
weren't actually testing code snippets in our user guides. As a result,
there are several broken code snippets in our guides.

This PR fixes some of those code snippets, and re-enables testing on the
user guides.

---------

Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
ljstrnadiii pushed a commit to ljstrnadiii/ray that referenced this pull request Aug 21, 2025
In ray-project#51334, we discovered we
weren't actually testing code snippets in our user guides. As a result,
there are several broken code snippets in our guides.

This PR fixes some of those code snippets, and re-enables testing on the
user guides.

---------

Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
Signed-off-by: ljstrnadiii <ljstrnadiii@gmail.com>
jugalshah291 pushed a commit to jugalshah291/ray_fork that referenced this pull request Sep 11, 2025
In ray-project#51334, we discovered we
weren't actually testing code snippets in our user guides. As a result,
there are several broken code snippets in our guides.

This PR fixes some of those code snippets, and re-enables testing on the
user guides.

---------

Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
Signed-off-by: jugalshah291 <shah.jugal291@gmail.com>
dstrodtman pushed a commit that referenced this pull request Oct 6, 2025
In #51334, we discovered we
weren't actually testing code snippets in our user guides. As a result,
there are several broken code snippets in our guides.

This PR fixes some of those code snippets, and re-enables testing on the
user guides.

---------

Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
landscapepainter pushed a commit to landscapepainter/ray that referenced this pull request Nov 17, 2025
In ray-project#51334, we discovered we
weren't actually testing code snippets in our user guides. As a result,
there are several broken code snippets in our guides.

This PR fixes some of those code snippets, and re-enables testing on the
user guides.

---------

Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

data Ray Data-related issues docs An issue or change related to documentation go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs][data] Documentation code coverage

4 participants