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 "Data Representations (internal)" #36435

Merged
merged 1 commit into from
Jun 20, 2023

Conversation

bveeramani
Copy link
Member

Why are these changes needed?

We shouldn't document Data internals that aren't relevant to developers.

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>
@amogkam
Copy link
Contributor

amogkam commented Jun 15, 2023

seems like block is being referenced here /ray/doc/source/data/examples/custom-datasource.rst:97: WARNING: undefined label: block-api, and generally is part of the DeveloperAPI for creating new datasources.

@bveeramani
Copy link
Member Author

seems like block is being referenced here /ray/doc/source/data/examples/custom-datasource.rst:97: WARNING: undefined label: block-api, and generally is part of the DeveloperAPI for creating new datasources.

@amogkam where would we put the Block reference? Maybe somewhere in the Dataset reference?

@amogkam
Copy link
Contributor

amogkam commented Jun 15, 2023

I think it's fine to keep under Data Representations. And we can downgrade it to developer API.

@raulchen raulchen merged commit ec72e01 into ray-project:master Jun 20, 2023
@bveeramani bveeramani deleted the remove-representation-docs branch June 20, 2023 18:28
amogkam pushed a commit that referenced this pull request Jun 22, 2023
#36435 removed the Block API references, but we reference the Block APIs in one of our examples. As a result, Sphinx is complaining. This PR fixes the issue by re-adding the Block API references.

Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
)

We shouldn't document Data internals that aren't relevant to developers.

Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
ray-project#36435 removed the Block API references, but we reference the Block APIs in one of our examples. As a result, Sphinx is complaining. This PR fixes the issue by re-adding the Block API references.

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.

3 participants