Skip to content
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

[Data][Docs] Remove built-in datasources from API ref #36428

Merged
merged 1 commit into from
Jun 14, 2023

Conversation

bveeramani
Copy link
Member

@bveeramani bveeramani commented Jun 14, 2023

Why are these changes needed?

The built-in datasource references take up space but don't provide value.

The references don't describe constructor arguments, and the class/method descriptions are all obvious. In any case, users shouldn't directly use built-in datasources -- they're internal abstractions.

(Note that the Datasource interface is still documented for developers)

image image

Related issue number

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 :(

Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Copy link
Contributor

@amogkam amogkam left a comment

Choose a reason for hiding this comment

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

Lgtm, thanks

@amogkam amogkam merged commit acb3edc into ray-project:master Jun 14, 2023
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
)

The built-in datasource references take up space but don't provide value.

The references don't describe constructor arguments, and the class/method descriptions are all obvious. In any case, users shouldn't directly use built-in datasources -- they're internal abstractions.

(Note that the Datasource interface is still documented for developers)

Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
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.

2 participants