Skip to content

Commit

Permalink
Update formatting for mostly when building docs
Browse files Browse the repository at this point in the history
Signed-off-by: James Campbell <[email protected]>
  • Loading branch information
jcampbell committed Oct 21, 2019
1 parent 04605a8 commit 7514913
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 4 deletions.
3 changes: 3 additions & 0 deletions docs/changelog/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

0.8.2__develop
-----------------
* Use higher precision for rendering 'mostly' parameter in data-docs
* Documentation fixes (thanks @DanielOliver!)
* Minor CLI wording fixes


0.8.1
Expand Down
3 changes: 2 additions & 1 deletion docs/features/data_context.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ option for selecting which expectations a DataContext returns.
In many simple projects, the datasource or generator name may be omitted and the DataContext will infer
the correct name when there is no ambiguity.

Similarly, if no expectation suite name is provided, the DataContext will assume the name "default".
The DataContext also provides other services, such as storing and substituting evaluation parameters during validation.
See :ref:`data_context_evaluation_parameter_store` for more information.

See the :ref:`data_context_reference` for more information.
2 changes: 1 addition & 1 deletion docs/getting_started/pipeline_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Finally, we can explicitly build batch kwargs, which can be particularly useful
my_explicit_batch_kwargs = {
"query": "select id, date, procedure_code from normalized_codes where date < '2019-07-01'"
}
batch = context.get_batch("my_source/my_generator/my_asset","my_expectations", my_explicit_batch_kwargs)
batch = context.get_batch("my_source/my_generator/my_asset", "my_expectations", my_explicit_batch_kwargs)
Validate
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/custom_expectations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,10 @@ structure below.
>> import great_expectations as ge
>> context = ge.DataContext()
>> my_df = context.get_batch("my_datasource/default/my_file")
>> my_df = context.get_batch(
"my_datasource/default/my_file",
"warning",
context.yield_batch_kwargs("my_datasource/default/my_file"))
>> my_df.expect_column_values_to_equal_1("all_twos")
{
Expand Down
7 changes: 6 additions & 1 deletion docs/reference/data_docs_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,12 @@ for how to profile a single batch of data and build documentation from the valid
context = ge.data_context.DataContext()
# load a batch from the data asset
batch = context.get_batch('ratings')
data_asset_name = context.normalize_data_asset_name('ratings')
context.creat_expectation_suite(data_asset_name, 'default'),
batch = context.get_batch(
data_asset_name=data_asset_name,
expectation_suite_name='default',
context.yield_batch_kwargs(data_asset_name))
# run the profiler on the batch - this returns an expectation suite and validation results for this suite
expectation_suite, validation_result = BasicDatasetProfiler().profile(batch)
Expand Down

0 comments on commit 7514913

Please sign in to comment.