Merge pull request #3 from great-expectations/develop

bring our fork in line with trunk
great-expectations · Nov 24, 2017 · 9392576 · 9392576
2 parents c5a595a + 9e06ec9
commit 9392576
Show file tree

Hide file tree

Showing 21 changed files with 33,391 additions and 88 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -85,7 +85,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+# html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/source/conventions.rst b/docs/source/conventions.rst
@@ -0,0 +1,16 @@
+.. _conventions:
+
+================================================================================
+Naming conventions
+================================================================================
+
+`expect_*_to_*`
+
+
+================================================================================
+Extending Great Expectations
+================================================================================
+
+When implementing an expectation defined in the base DataSet for a new backend, add the ``@DocInherit` decorator first to use the default DataSet documentation for the expectation. That can help users of your DataSet see consistent documentation no matter which backend is implementing the great_expectations API.
+
+``@DocInherit` overrides your function's __get__ method with one that will replace the local docstring with the docstring from its parent. It is defined in `dataset.util`.
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
@@ -18,13 +18,17 @@ Missing values, unique values, and types
 * :func:`expect_column_values_to_not_be_null <great_expectations.dataset.base.DataSet.expect_column_values_to_not_be_null>`
 * :func:`expect_column_values_to_be_null <great_expectations.dataset.base.DataSet.expect_column_values_to_be_null>`
 * :func:`expect_column_values_to_be_of_type <great_expectations.dataset.base.DataSet.expect_column_values_to_be_of_type>`
+* :func:`expect_column_values_to_be_in_type_list <great_expectations.dataset.base.DataSet.expect_column_values_to_be_in_type_list>`
 
 Sets and ranges
 --------------------------------------------------------------------------------
 
 * :func:`expect_column_values_to_be_in_set <great_expectations.dataset.base.DataSet.expect_column_values_to_be_in_set>`
 * :func:`expect_column_values_to_not_be_in_set <great_expectations.dataset.base.DataSet.expect_column_values_to_not_be_in_set>`
 * :func:`expect_column_values_to_be_between <great_expectations.dataset.base.DataSet.expect_column_values_to_be_between>`
+* :func:`expect_column_values_to_be_increasing <great_expectations.dataset.base.DataSet.expect_column_values_to_be_increasing>`
+* :func:`expect_column_values_to_be_decreasing <great_expectations.dataset.base.DataSet.expect_column_values_to_be_decreasing>`
+
 
 String matching
 --------------------------------------------------------------------------------
@@ -56,7 +60,7 @@ Datetime and JSON parsing
 
 * :func:`expect_column_values_to_match_strftime_format <great_expectations.dataset.base.DataSet.expect_column_values_to_match_strftime_format>`
 * :func:`expect_column_values_to_be_dateutil_parseable <great_expectations.dataset.base.DataSet.expect_column_values_to_be_dateutil_parseable>`
-* :func:`expect_column_values_to_be_valid_json <great_expectations.dataset.base.DataSet.expect_column_values_to_be_valid_json>`
+* :func:`expect_column_values_to_be_json_parseable <great_expectations.dataset.base.DataSet.expect_column_values_to_be_json_parseable>`
 * :func:`expect_column_values_to_match_json_schema <great_expectations.dataset.base.DataSet.expect_column_values_to_match_json_schema>`
 
 Aggregate functions
@@ -67,6 +71,8 @@ Aggregate functions
 * :func:`expect_column_stdev_to_be_between <great_expectations.dataset.base.DataSet.expect_column_stdev_to_be_between>`
 * :func:`expect_column_unique_value_count_to_be_between <great_expectations.dataset.base.DataSet.expect_column_unique_value_count_to_be_between>`
 * :func:`expect_column_proportion_of_unique_values_to_be_between <great_expectations.dataset.base.DataSet.expect_column_proportion_of_unique_values_to_be_between>`
+* :func:`expect_column_most_common_value_to_be <great_expectations.dataset.base.DataSet.expect_column_most_common_value_to_be>`
+* :func:`expect_column_most_common_value_to_be_in_set <great_expectations.dataset.base.DataSet.expect_column_most_common_value_to_be_in_set>`
 
 
 Distributional functions

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -24,7 +24,7 @@ Advanced
 
    output_format
    custom_expectations
-   naming_conventions
+   conventions
 
 Indices and tables
 ------------------

diff --git a/docs/source/intro.rst b/docs/source/intro.rst
@@ -48,13 +48,13 @@ branch-name:
 
 .. code-block:: bash
 
-	$ pip install git+git://github.com/abegong/great_expectations.git@develop
+    $ pip install git+git://github.com/abegong/great_expectations.git@develop
 
 hash (use the specific hash of the commit you want):
 
 .. code-block:: bash
 
-	$ pip install git+git://github.com/abegong/great_expectations.git@29f87309e916816ab509f906a8c2ede710bf0ee5	
+    $ pip install git+git://github.com/abegong/great_expectations.git@29f87309e916816ab509f906a8c2ede710bf0ee5
 
 
 .. _`pipeline testing`: irc://freenode.net

diff --git a/docs/source/naming_conventions.rst b/docs/source/naming_conventions.rst