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-1694712] Remove _emit_ast and _ast from docs. #2701

Merged
merged 5 commits into from
Dec 5, 2024

Conversation

sfc-gh-lspiegelberg
Copy link
Contributor

@sfc-gh-lspiegelberg sfc-gh-lspiegelberg commented Dec 2, 2024

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

  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.
    • I acknowledge that I have ensured my changes to be thread-safe. Follow the link for more information: Thread-safe Developer Guidelines
  3. Please describe how your code solves the related issue.

    AST introduces in function signatures (private) parameters _emit_ast and _ast. This PR modifies the sphinx-build to not emit these parameters into the docs. To check that the generation is successful, run e.e. from the docs folder

grep -rl --include "*.html" "_emit_ast" build/html
grep -rl --include "*.html" "_ast" build/html

@sfc-gh-lspiegelberg sfc-gh-lspiegelberg 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 Dec 2, 2024
@sfc-gh-lspiegelberg sfc-gh-lspiegelberg marked this pull request as ready for review December 2, 2024 22:14
@sfc-gh-lspiegelberg sfc-gh-lspiegelberg requested a review from a team as a code owner December 2, 2024 22:14
@sfc-gh-lspiegelberg sfc-gh-lspiegelberg enabled auto-merge (squash) December 2, 2024 23:11
@sfc-gh-aalam
Copy link
Contributor

Screenshot 2024-12-03 at 10 03 12 AM

can you look at these formatting issues where we see double closed parenthesis

@sfc-gh-aalam
Copy link
Contributor

Screenshot 2024-12-03 at 10 04 07 AM

there are similar issues I noticed in column and dataframe

docs/source/conf.py Outdated Show resolved Hide resolved
@sfc-gh-lspiegelberg sfc-gh-lspiegelberg enabled auto-merge (squash) December 4, 2024 23:35
docs/source/conf.py Outdated Show resolved Hide resolved
docs/source/conf.py Outdated Show resolved Hide resolved
Copy link
Contributor

@sfc-gh-aling sfc-gh-aling left a comment

Choose a reason for hiding this comment

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

pre-approving, assuming you will address Afroz's comment

@sfc-gh-lspiegelberg sfc-gh-lspiegelberg merged commit 41fb8d5 into main Dec 5, 2024
39 checks passed
@sfc-gh-lspiegelberg sfc-gh-lspiegelberg deleted the ls-SNOW-1694712-fix-docs branch December 5, 2024 01:17
@github-actions github-actions bot locked and limited conversation to collaborators Dec 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants