cudf icon indicating copy to clipboard operation
cudf copied to clipboard

Published 20 hours ago • verified publisher icon rapidsai

Doc: interleave columns pandas compat

Open raybellwaves opened this issue 3 months ago • 9 comments

Three changes here. Happy to leave any of them out if desired.

  1. Update the pandas-compat note in query to use intersphinx mapping and the :func:pandas.DataFrame.query should create a hyperlink to https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.query.html
  2. Add a note on how to do interleave_columns using pandas.
  3. Added a note in the development guide that :func:pandas.API_NAME is preferred over $API_NAME. Happy to have feedback on this.

Not tested the docs build yet as i'm working on my mac. I think the docs are built during CI and I can then test it or i'll report back if I get to testing it locally beforehand. The syntax of the docs mapping should work (e.g. see https://github.com/geopandas/geopandas/pull/3225) but we can see before merging

raybellwaves avatar Mar 25 '24 03:03 raybellwaves

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

copy-pr-bot[bot] avatar Mar 25 '24 03:03 copy-pr-bot[bot]

/ok to test

bdice avatar Mar 25 '24 16:03 bdice

We'll need #15392 to merge to 24.04, then forward-merge 24.04 to 24.06, then merge 24.06 into this PR before the docs will build correctly.

bdice avatar Mar 26 '24 19:03 bdice

Had some issues with the pandas sphinx intermapping as well displaying a mapping in the pandas-compat directive (https://github.com/orgs/sphinx-doc/discussions/12212). I'll open back up if I make any progress

raybellwaves avatar Mar 30 '24 19:03 raybellwaves

I'm holding off reviewing this until #15531 is in and we know that the pandas intersphinx mapping is working as expected. Happy to pick it back up again afterwards!

vyasr avatar Apr 17 '24 22:04 vyasr

@vyasr no rush. I think i want to take a look at the pandas-compat sphinx extension first

raybellwaves avatar Apr 18 '24 02:04 raybellwaves

OK sounds good. Now that #15531 is merged feel free to ping again when you think this PR is ready for another look.

vyasr avatar Apr 20 '24 00:04 vyasr

OK sounds good. Now that #15531 is merged feel free to ping again when you think this PR is ready for another look.

This is ready for review now.

raybellwaves avatar Apr 22 '24 01:04 raybellwaves

/okay to test

galipremsagar avatar Apr 22 '24 14:04 galipremsagar

/merge

wence- avatar May 02 '24 17:05 wence-