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/filesystem/how_to_connect_to_one_or_more_files_using_spark" #7927

Conversation

alexsherstinsky
Copy link
Contributor

Scope

  • Putting snippets under test and correcting documentation contents.

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!

Alex Sherstinsky and others added 30 commits May 16, 2023 11:25
…k/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-22
…a_assets/how_to_organize_batches_in_a_file_based_data_asset.md


Good suggestion -- comitted.

Co-authored-by: T Pham <2117313+TrangPham@users.noreply.github.com>
…p_filesystem_data_asset_if_batching_regex_matches_multiple_files.md


Thanks for catching the typo.

Co-authored-by: T Pham <2117313+TrangPham@users.noreply.github.com>
…p_filesystem_data_asset_if_batching_regex_matches_multiple_files.md


Thanks!

Co-authored-by: T Pham <2117313+TrangPham@users.noreply.github.com>
…stinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-22' into feature/DX-469/DX-441/alexsherstinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-22
…rus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-22
…k/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-23
…k/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-22
…ocuments_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-22' into feature/DX-469/DX-441/alexsherstinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-23
…ocuments_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-22' into feature/DX-469/DX-441/alexsherstinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-23
…k/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-23
…a_assets/how_to_organize_batches_in_a_sql_based_data_asset.md

Co-authored-by: T Pham <2117313+TrangPham@users.noreply.github.com>
Co-authored-by: T Pham <2117313+TrangPham@users.noreply.github.com>
Co-authored-by: T Pham <2117313+TrangPham@users.noreply.github.com>
…rus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-23
…rus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-23
…rus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-23
…rus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-23
…rus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_16-23
…k/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25
@alexsherstinsky alexsherstinsky force-pushed the feature/DX-469/DX-441/alexsherstinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25 branch from 1c919a5 to 33ace8a Compare May 18, 2023 16:29
Alex Sherstinsky added 2 commits May 18, 2023 10:17
…k/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25
@alexsherstinsky alexsherstinsky force-pushed the feature/DX-469/DX-441/alexsherstinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25 branch from 1d674ad to e5d0da1 Compare May 18, 2023 17:18
Copy link
Contributor

@Shinnnyshinshin Shinnnyshinshin left a comment

Choose a reason for hiding this comment

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

Thank you @alexsherstinsky, some requested changes around methods added to the @public_api

Alex Sherstinsky added 2 commits May 18, 2023 12:42
…k/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25
@alexsherstinsky alexsherstinsky force-pushed the feature/DX-469/DX-441/alexsherstinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25 branch from bad4167 to 6d79f2d Compare May 18, 2023 19:43
Alex Sherstinsky added 2 commits May 18, 2023 13:41
…k/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25
@alexsherstinsky alexsherstinsky force-pushed the feature/DX-469/DX-441/alexsherstinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25 branch from a44d278 to d8763e5 Compare May 18, 2023 20:42
Copy link
Contributor

@Shinnnyshinshin Shinnnyshinshin left a comment

Choose a reason for hiding this comment

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

LGTM. Rendering on Netlify looks good too

Copy link
Contributor

@Shinnnyshinshin Shinnnyshinshin left a comment

Choose a reason for hiding this comment

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

LGTM. Rendering on Netlify looks good too

Copy link
Contributor

@billdirks billdirks left a comment

Choose a reason for hiding this comment

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

Thanks for doing this @alexsherstinsky. One small grammatical comment and a comment about using a deprecation decorator instead of inlining in the docstring.

Convenience method to run "table.head" metric.
"""Convenience method to return the first several rows or records from a Batch of data.

(To be deprecated in favor of using methods in "MetricsCalculator" class.)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we have an @deprecated_method_or_class decorator to mark things as deprecated. I haven't used it but you can find examples in the code or ask @anthonyburdi. Using it will mark it as deprecated in our published docs.

alexsherstinsky and others added 3 commits May 18, 2023 14:22
…esystem/how_to_connect_to_one_or_more_files_using_spark.md


Thanks you!

Co-authored-by: Bill Dirks <bill@greatexpectations.io>
…stinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25' into feature/DX-469/DX-441/alexsherstinsky/link/docusaurus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25
Copy link
Contributor

@billdirks billdirks left a comment

Choose a reason for hiding this comment

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

Copy link
Contributor

@billdirks billdirks left a comment

Choose a reason for hiding this comment

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

@alexsherstinsky
Copy link
Contributor Author

LGTM.

There is 1 deprecated docstring left that needs to be removed: https://github.com/great-expectations/great_expectations/pull/7927/files#diff-c0dc20209b0c340812ba02fcc9774b23c116256e45c13de7769a26ad8210b4d9R82

Done -- thanks for catching it (it was a typo).

…rus_documents_should_use_python_code_script_tags_referring_to_integration_tests-2023_05_17-25
@alexsherstinsky alexsherstinsky merged commit 2ee6762 into develop May 18, 2023
58 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_17-25 branch May 18, 2023 23:21
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

3 participants