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

[DOC] Dask_cudf docs have a FIXME and orange warning section in legacy, stable, and nightly. #14299

Closed
taureandyernv opened this issue Oct 19, 2023 · 3 comments
Labels
0 - Backlog In queue waiting for assignment dask Dask issue doc Documentation

Comments

@taureandyernv
Copy link
Contributor

Report incorrect documentation

Location of incorrect documentation
https://docs.rapids.ai/api/dask-cudf/stable/api/#dask_cudf.concat

Describe the problems or issues found in the documentation
Our dask_cudf docs have a big orange warning section with a FIXME: where should the following live? in stable, legacy, and nightly

Suggested fix for documentation
May I suggest that dask_cudf.concat() go under DataFrames and Series, and dask_cudf.from_delayed() stay in Creating and storing DataFrames?

@taureandyernv taureandyernv added Needs Triage Need team to review and classify doc Documentation labels Oct 19, 2023
@GregoryKimball GregoryKimball added 0 - Backlog In queue waiting for assignment dask Dask issue helps: Dask and removed Needs Triage Need team to review and classify labels Nov 9, 2023
@GregoryKimball
Copy link
Contributor

@rjzamora Would you please check if this issue is still needed? Thank you for your help!

@rjzamora
Copy link
Member

rjzamora commented Nov 9, 2023

May I suggest that dask_cudf.concat() go under DataFrames and Series, and dask_cudf.from_delayed() stay in Creating and storing DataFrames?

Thanks for raising @taureandyernv ! I think your suggested solution would be fine. Are you interested in contributing that change?

Note that it may also be fine to remove concat and from_delayed from the documentation altogether given that the dask_cudf version is just calling the dask.dataframe version directly (as is). In fact, I should probably take some time to deprecate the redundant definitions in the dask_cudf namespace, and revise the documentation to better clarify that dask_cudf.DataFrame/Series is a dask.dataframe.DataFrame/Series, and that users should rarely need to import dask_dataframe directly.

copy-pr-bot bot pushed a commit that referenced this issue Nov 20, 2023
rapids-bot bot pushed a commit that referenced this issue Nov 21, 2023
Move `from_delayed` and `concat` to appropriate subsections.

- Closes #14299

Authors:
  - Lawrence Mitchell (https://github.com/wence-)
  - Vyas Ramasubramani (https://github.com/vyasr)

Approvers:
  - Bradley Dice (https://github.com/bdice)
  - Vyas Ramasubramani (https://github.com/vyasr)

URL: #14454
@wence-
Copy link
Contributor

wence- commented Nov 21, 2023

I merged this to 24.02 (so it wasn't auto-closed) since it wasn't critical for 23.12. But this should be fixed in nightlies.

@wence- wence- closed this as completed Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 - Backlog In queue waiting for assignment dask Dask issue doc Documentation
Projects
Archived in project
Development

No branches or pull requests

4 participants