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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Update Template Link in Create a Custom Batch Expectation #9731

Merged
merged 3 commits into from
Apr 10, 2024
Merged

[DOCS] Update Template Link in Create a Custom Batch Expectation #9731

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2357caf
Preliminary edits.
kwcanuck Apr 10, 2024
ad8737e
Minor edits.
kwcanuck Apr 10, 2024
902f28d
Merge branch 'develop' into custom-template-link-update
kwcanuck Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 3 additions & 4 deletions ...tations/creating_custom_expectations/how_to_create_custom_batch_expectations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This guide will walk you through the process of creating your own custom `BatchE
## Choose a name for your Expectation

First, decide on a name for your own Expectation. By convention, `BatchExpectations` always start with `expect_table_`.
For more on Expectation naming conventions, see the [Expectations section](../../../contributing/style_guides/code_style.md#expectations) of the Code Style Guide.
For more on Expectation naming conventions, see the [Expectations section](/oss/contributing/style_guides/code_style.md#expectations) of the Code Style Guide.

Your Expectation will have two versions of the same name: a `CamelCaseName` and a `snake_case_name`. For example, this tutorial will use:

Expand All @@ -29,14 +29,13 @@ Your Expectation will have two versions of the same name: a `CamelCaseName` and

By convention, each Expectation is kept in its own python file, named with the snake_case version of the Expectation's name.

You can find the template file for a custom [BatchExpectation here](https://github.com/great-expectations/great_expectations/blob/develop/examples/expectations/batch_expectation_template.py).
Download the file, place it in the appropriate directory, and rename it to the appropriate name.
Download the custom [BatchExpectation template](batch_expectation_template.py) and then run the following code to rename it and save it to a directory:

```bash
cp batch_expectation_template.py /SOME_DIRECTORY/expect_batch_columns_to_be_unique.py
```

### Storing Expectation files
### Store Expectation files

During development, you don't need to store Expectation files in a specific location. Expectation files are self-contained and can be executed anywhere as long as GX is installed However, to use your new Expectation with other GX components, you'll need to make sure the file is stored one of the following locations:

Expand Down