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

[FEATURE] Implementing Python code snippets under test for "https://docs.greatexpectations.io/docs/guides/connecting_to_your_data/fluent/cloud/how_to_connect_to_data_on_s3_using_pandas" #7941

Conversation

alexsherstinsky
Copy link
Contributor

@alexsherstinsky alexsherstinsky commented May 19, 2023

Scope

  • Putting snippets under test and correcting/updating documentation contents.
  • Utilizing "Compatibility for AWS S3" in more modules.

Remarks

  • JIRA: DX-469/DX-441
  • Description of PR changes above includes a link to an existing GitHub issue

  • PR title is prefixed with one of: [BUGFIX], [FEATURE], [DOCS], [MAINTENANCE], [CONTRIB]

  • Code is linted

    black .
    
    ruff . --fix
    
  • Appropriate tests and docs have been updated

For more details, see our Contribution Checklist, Coding style guide, and Documentation style guide.

After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!

@netlify
Copy link

netlify bot commented May 19, 2023

Deploy Preview for niobium-lead-7998 canceled.

Name Link
🔨 Latest commit a3931e2
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/64679eea5bdccd0008ee4b86

@ghost
Copy link

ghost commented May 19, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@alexsherstinsky alexsherstinsky marked this pull request as ready for review May 19, 2023 15:48
@alexsherstinsky alexsherstinsky enabled auto-merge (squash) May 19, 2023 15:49
@alexsherstinsky alexsherstinsky requested review from a team May 19, 2023 15:49
…rus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_19-29

assert datasource_name in context.datasources

# Python
Copy link
Contributor

Choose a reason for hiding this comment

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

Does commenting python here add syntax highlighting?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@TrangPham Good question -- I am not sure. It may not be necessary, because in the document, there is a "python" tag. However, this has been the style I inherited from others' examples and found it to be aesthetically nice. Maybe we can try locally using invoke docs and see whether or not it adds anything to the HTML view. Thanks.

@@ -54,10 +48,11 @@ def aws_credentials() -> None:
os.environ["AWS_SESSION_TOKEN"] = "testing"


@pytest.mark.skipif(not aws.boto3)
Copy link
Contributor

Choose a reason for hiding this comment

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

👍🏻

@alexsherstinsky alexsherstinsky merged commit 421441c into develop May 19, 2023
56 checks passed
@alexsherstinsky alexsherstinsky deleted the feature/DX-469/DX-441/alexsherstinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_19-29 branch May 19, 2023 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants