Deploying to gh-pages from @ b23da8e 🚀

capitalone · Oct 30, 2024 · bf03ec8 · bf03ec8
1 parent 1069d2c
commit bf03ec8
Show file tree

Hide file tree

Showing 23 changed files with 109 additions and 88 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 1f4b85819b4429b3833c6521f227662a
+config: 6c337fb4280de0804707d0f7392a1a76
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/snowflake_usage.doctree b/.doctrees/snowflake_usage.doctree
diff --git a/_sources/snowflake_usage.rst.txt b/_sources/snowflake_usage.rst.txt
@@ -6,11 +6,12 @@ For ``SnowflakeCompare``
 - ``on_index`` is not supported.
 - Joining is done using ``EQUAL_NULL`` which is the equality test that is safe for null values.
 - Compares ``snowflake.snowpark.DataFrame``, which can be provided as either raw Snowflake dataframes
-or the as the names of full names of valid snowflake tables, which we will process into Snowpark dataframes.
+  or as the names of full names of valid snowflake tables, which we will process into Snowpark dataframes.
 
 
-SnowflakeCompare Object Setup
----------------------------------------------------
+SnowflakeCompare setup
+----------------------
+
 There are two ways to specify input dataframes for ``SnowflakeCompare``
 
 Provide Snowpark dataframes
@@ -66,11 +67,12 @@ Provide Snowpark dataframes
     print(compare.report())
 
 
-Provide the full name (``{db}.{schema}.{table_name}``) of valid Snowflake tables
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Provide the full name (``db.schema.table_name``) of valid Snowflake tables
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Given the dataframes from the prior examples...
 
 .. code-block:: python
+
     df_1.write.mode("overwrite").save_as_table("toy_table_1")
     df_2.write.mode("overwrite").save_as_table("toy_table_2")
 
@@ -210,6 +212,7 @@ There are a few convenience methods and attributes available after the compariso
     print(compare.df2_unq_columns())
     # OrderedSet()
 
+
 Duplicate rows
 --------------
 
@@ -260,9 +263,10 @@ as uniquely in the second.
 
 Additional considerations
 -------------------------
-- It is strongly recommended against joining on float columns (or any column with floating point precision).
-Columns joining tables are compared on the basis of an exact comparison, therefore if the values comparing
-your float columns are not exact, you will likely get unexpected results.
-- Case-sensitive columns are only partially supported. We essentially treat case-sensitive
-columns as if they are case-insensitive. Therefore you may use case-sensitive columns as long as
-you don't have several columns with the same name differentiated only be case sensitivity.
+
+- It is strongly recommended against joining on float columns or any column with floating point precision.
+  Columns joining tables are compared on the basis of an exact comparison, therefore if the values
+  comparing your float columns are not exact, you will likely get unexpected results.
+- Case-sensitive columns are only partially supported. We essentially treat case-sensitive columns as
+  if they are case-insensitive. Therefore you may use case-sensitive columns as long as you don't have several
+  columns with the same name differentiated only be case sensitivity.
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.14.2',
+    VERSION: '0.14.3',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/api/datacompy.html b/api/datacompy.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="datacompy.spark package" href="datacompy.spark.html" /><link rel="prev" title="datacompy" href="modules.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>datacompy package - datacompy 0.14.2 documentation</title>
+        <title>datacompy package - datacompy 0.14.3 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">datacompy 0.14.2 documentation</div></a>
+      <a href="../index.html"><div class="brand">datacompy 0.14.3 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -190,7 +190,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">datacompy 0.14.2 documentation</span>
+  <span class="sidebar-brand-text">datacompy 0.14.3 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -3587,7 +3587,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=0dc20415"></script>
+</div><script src="../_static/documentation_options.js?v=a9ba800c"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/api/datacompy.spark.html b/api/datacompy.spark.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="prev" title="datacompy package" href="datacompy.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>datacompy.spark package - datacompy 0.14.2 documentation</title>
+        <title>datacompy.spark package - datacompy 0.14.3 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">datacompy 0.14.2 documentation</div></a>
+      <a href="../index.html"><div class="brand">datacompy 0.14.3 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -190,7 +190,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">datacompy 0.14.2 documentation</span>
+  <span class="sidebar-brand-text">datacompy 0.14.3 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -1355,7 +1355,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=0dc20415"></script>
+</div><script src="../_static/documentation_options.js?v=a9ba800c"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/api/modules.html b/api/modules.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="datacompy package" href="datacompy.html" /><link rel="prev" title="Developer Instructions" href="../developer_instructions.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>datacompy - datacompy 0.14.2 documentation</title>
+        <title>datacompy - datacompy 0.14.3 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">datacompy 0.14.2 documentation</div></a>
+      <a href="../index.html"><div class="brand">datacompy 0.14.3 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -190,7 +190,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">datacompy 0.14.2 documentation</span>
+  <span class="sidebar-brand-text">datacompy 0.14.3 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -558,7 +558,7 @@ <h1>datacompy<a class="headerlink" href="#datacompy" title="Link to this heading
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=0dc20415"></script>
+</div><script src="../_static/documentation_options.js?v=a9ba800c"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/benchmark.html b/benchmark.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Developer Instructions" href="developer_instructions.html" /><link rel="prev" title="Fugue Detail" href="fugue_usage.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>Benchmarks - datacompy 0.14.2 documentation</title>
+        <title>Benchmarks - datacompy 0.14.3 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">datacompy 0.14.2 documentation</div></a>
+      <a href="index.html"><div class="brand">datacompy 0.14.3 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -190,7 +190,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">datacompy 0.14.2 documentation</span>
+  <span class="sidebar-brand-text">datacompy 0.14.3 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -466,7 +466,7 @@ <h2>TLDR<a class="headerlink" href="#tldr" title="Link to this heading">¶</a></
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=0dc20415"></script>
+</div><script src="_static/documentation_options.js?v=a9ba800c"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/developer_instructions.html b/developer_instructions.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="datacompy" href="api/modules.html" /><link rel="prev" title="Benchmarks" href="benchmark.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>Developer Instructions - datacompy 0.14.2 documentation</title>
+        <title>Developer Instructions - datacompy 0.14.3 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">datacompy 0.14.2 documentation</div></a>
+      <a href="index.html"><div class="brand">datacompy 0.14.3 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -190,7 +190,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">datacompy 0.14.2 documentation</span>
+  <span class="sidebar-brand-text">datacompy 0.14.3 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -456,7 +456,7 @@ <h2>Generating distribution archives (PyPI)<a class="headerlink" href="#generati
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=0dc20415"></script>
+</div><script src="_static/documentation_options.js?v=a9ba800c"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/fugue_usage.html b/fugue_usage.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Benchmarks" href="benchmark.html" /><link rel="prev" title="Polars Usage" href="polars_usage.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>Fugue Detail - datacompy 0.14.2 documentation</title>
+        <title>Fugue Detail - datacompy 0.14.3 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">datacompy 0.14.2 documentation</div></a>
+      <a href="index.html"><div class="brand">datacompy 0.14.3 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -190,7 +190,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">datacompy 0.14.2 documentation</span>
+  <span class="sidebar-brand-text">datacompy 0.14.3 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -434,7 +434,7 @@ <h2>Future releases<a class="headerlink" href="#future-releases" title="Link to
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=0dc20415"></script>
+</div><script src="_static/documentation_options.js?v=a9ba800c"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/genindex.html b/genindex.html
@@ -4,7 +4,7 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
 
-    <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 --><title>Index - datacompy 0.14.2 documentation</title>
+    <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 --><title>Index - datacompy 0.14.3 documentation</title>
 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
@@ -164,7 +164,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">datacompy 0.14.2 documentation</div></a>
+      <a href="index.html"><div class="brand">datacompy 0.14.3 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -188,7 +188,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">datacompy 0.14.2 documentation</span>
+  <span class="sidebar-brand-text">datacompy 0.14.3 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -1072,7 +1072,7 @@ <h2>U</h2>
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=0dc20415"></script>
+</div><script src="_static/documentation_options.js?v=a9ba800c"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/index.html b/index.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Installation" href="install.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>datacompy 0.14.2 documentation</title>
+        <title>datacompy 0.14.3 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="#"><div class="brand">datacompy 0.14.2 documentation</div></a>
+      <a href="#"><div class="brand">datacompy 0.14.3 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -190,7 +190,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="#">
 
 
-  <span class="sidebar-brand-text">datacompy 0.14.2 documentation</span>
+  <span class="sidebar-brand-text">datacompy 0.14.3 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -441,7 +441,7 @@ <h1>Contents<a class="headerlink" href="#contents" title="Link to this heading">
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="snowflake_usage.html">Snowflake Usage</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="snowflake_usage.html#snowflakecompare-object-setup">SnowflakeCompare Object Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="snowflake_usage.html#snowflakecompare-setup">SnowflakeCompare setup</a></li>
 <li class="toctree-l2"><a class="reference internal" href="snowflake_usage.html#reports">Reports</a></li>
 <li class="toctree-l2"><a class="reference internal" href="snowflake_usage.html#convenience-methods">Convenience Methods</a></li>
 <li class="toctree-l2"><a class="reference internal" href="snowflake_usage.html#duplicate-rows">Duplicate rows</a></li>
@@ -652,7 +652,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Li
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=0dc20415"></script>
+</div><script src="_static/documentation_options.js?v=a9ba800c"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=5fa4622c"></script>