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

SNOW-1635365: Update snowpark pandas imports in method documentation #2204

Merged
merged 5 commits into from
Sep 5, 2024

Conversation

sfc-gh-joshi
Copy link
Contributor

  1. Which Jira issue is this PR addressing? Make sure that there is an accompanying issue to your PR.

    Fixes SNOW-1635365 (resolves SNOW-1635365: ImportError when importing modin.pandas #2139)

  2. Fill out the following pre-review checklist:

    • I am adding a new automated test(s) to verify correctness of my new code
      • If this test skips Local Testing mode, I'm requesting review from @snowflakedb/local-testing
    • I am adding new logging messages
    • I am adding a new telemetry message
    • I am adding new credentials
    • I am adding a new dependency
    • If this is a new feature/behavior, I'm adding the Local Testing parity changes.
  3. Please describe how your code solves the related issue.

A few methods in documentation had an outdated import method for Snowpark pandas (import snowflake.snowpark.modin.pandas as pd). This PR updates docstrings to use the correct method (import modin.pandas as pd; import snowflake.snowpark.modin.plugin).

@sfc-gh-joshi sfc-gh-joshi requested a review from a team as a code owner August 30, 2024 22:31
@sfc-gh-joshi sfc-gh-joshi added NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md NO-PANDAS-CHANGEDOC-UPDATES This PR does not update Snowpark pandas docs labels Aug 30, 2024
@sfc-gh-joshi sfc-gh-joshi force-pushed the joshi-SNOW-1635365-update-docs-imports branch from c5c0253 to 6aef6f3 Compare September 4, 2024 04:39
@sfc-gh-joshi
Copy link
Contributor Author

FYI @sfc-gh-azhan @sfc-gh-nkrishna I had to make an additional change to the default argument of the typ flag of pd.read_json to get doctests to pass. CI was failing on src/snowflake/snowpark/modin/plugin/extensions/pd_overrides.py::snowpark.modin.plugin.extensions.pd_overrides.read_json, but the failure occurred only if the full doctest suite was run (not sure if there's a smaller subset that can trigger it). I suspect there might be some hidden conflicts between the read_* methods we define in snowflake/snowpark/modin/pandas/io.py and those we define in snowflake/snowpark/modin/plugin/extensions/pd_overrides.py; I'll investigate further in a separate PR if I have time before GA.

@sfc-gh-joshi sfc-gh-joshi merged commit 3a2f1a1 into main Sep 5, 2024
34 checks passed
@sfc-gh-joshi sfc-gh-joshi deleted the joshi-SNOW-1635365-update-docs-imports branch September 5, 2024 22:14
@github-actions github-actions bot locked and limited conversation to collaborators Sep 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md NO-PANDAS-CHANGEDOC-UPDATES This PR does not update Snowpark pandas docs snowpark-pandas
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SNOW-1635365: ImportError when importing modin.pandas
3 participants