Skip to content

[docs][data] Documentation code coverage #52536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
9 tasks
richardliaw opened this issue Apr 22, 2025 · 2 comments · May be fixed by #52560
Open
9 tasks

[docs][data] Documentation code coverage #52536

richardliaw opened this issue Apr 22, 2025 · 2 comments · May be fixed by #52560
Labels
bug Something that is supposed to be working; but isn't data Ray Data-related issues docs An issue or change related to documentation good-first-issue Great starter issue for someone just starting to contribute to Ray P1 Issue that should be fixed within a few weeks

Comments

@richardliaw
Copy link
Contributor

richardliaw commented Apr 22, 2025

Doctest infrastructure stopped working at some point, and we only caught it recently when Ed refactored some of the code. There are several failures across our documentation:

ray/doc/BUILD

Lines 455 to 465 in d87d2fd

# These tests are currently failing.
"source/data/loading-data.rst",
"source/data/data-internals.rst",
"source/data/inspecting-data.rst",
"source/data/loading-data.rst",
"source/data/performance-tips.rst",
"source/data/saving-data.rst",
"source/data/working-with-images.rst",
"source/data/working-with-llms.rst",
"source/data/working-with-pytorch.rst",
],

Originally posted by @bveeramani in #52534

  • "source/data/loading-data.rst",
  • "source/data/data-internals.rst",
  • "source/data/inspecting-data.rst",
  • "source/data/loading-data.rst",
  • "source/data/performance-tips.rst",
  • "source/data/saving-data.rst" ([Data][Docs] Code snippet in "Saving Data" doesn't work #52534)
  • "source/data/working-with-images.rst",
  • "source/data/working-with-llms.rst",
  • "source/data/working-with-pytorch.rst",
@richardliaw richardliaw added bug Something that is supposed to be working; but isn't data Ray Data-related issues docs An issue or change related to documentation good-first-issue Great starter issue for someone just starting to contribute to Ray P1 Issue that should be fixed within a few weeks labels Apr 22, 2025
@Bye-legumes
Copy link
Contributor

let me and @zhaoch23 verify some of them

@Bye-legumes Bye-legumes linked a pull request Apr 23, 2025 that will close this issue
8 tasks
@zhaoch23
Copy link
Contributor

"source/data/loading-data.rst" is failing because of this issue: #48689

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something that is supposed to be working; but isn't data Ray Data-related issues docs An issue or change related to documentation good-first-issue Great starter issue for someone just starting to contribute to Ray P1 Issue that should be fixed within a few weeks
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants