updated args in v0.0.9

lshpaner · Sep 17, 2024 · 5e39945 · 5e39945
1 parent 21fdbfc
commit 5e39945
Show file tree

Hide file tree

Showing 145 changed files with 50,445 additions and 27 deletions.
diff --git a/docs/.doctrees/changelog.doctree b/docs/.doctrees/changelog.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/_sources/changelog.rst.txt b/docs/_sources/changelog.rst.txt
@@ -35,20 +35,29 @@ Improved error messages and validation checks across multiple functions to preve
 
 **Visualization Enhancements**
 
-DataFrame Columns: Added a ``background_color`` variable to ``dataframe_columns```, allowing the user to enter a string representing a color name, or hex value. Try/Except on the output, in case the end user has a deprecated version of Pandas, where the styler would use `hide()` instead of `hide_index()`. The highlighted columns allow for easier null versus unique value analysis.
+DataFrame Columns: Added a ``background_color`` variable to ``dataframe_columns```, 
+allowing the user to enter a string representing a color name, or hex value. 
+Try/Except on the output, in case the end user has a deprecated version of Pandas, 
+where the styler would use ``hide()`` instead of ``hide_index()``. The highlighted 
+columns allow for easier null versus unique value analysis.  
 
-The docstring now clearly describes the purpose of the function—analyzing DataFrame columns to provide summary statistics.
+The docstring now clearly describes the purpose of the function—analyzing 
+DataFrame columns to provide summary statistics.
 
 Args:
-- The ``df`` argument is specified as a ``pandas.DataFrame``.
-- The ``background_color`` argument is marked as optional, with a brief description of its role.
-- The ``return_df`` argument is also marked as optional, explaining what it controls.
 
-Returns: The return type is specified as ``pandas.DataFrame``, with a clear explanation of the difference based on the ``return_df`` flag.
+- The ``df`` argument is specified as a ``pandas.DataFrame``.  
 
-KDE Distribution Plots: Improved ``kde_distributions()`` with enhanced options for log scaling, mean/median plotting, custom standard deviation lines, and better handling of legends and scientific notation.
+- The ``background_color`` argument is marked as optional, with a brief description of its role.  
 
-Scatter Plots: Enhanced ``scatter_fit_plot()`` with support for hue-based coloring, best fit lines, correlation display, and flexible grid plotting options.
+- The ``return_df`` argument is also marked as optional, explaining what it controls.    
+
+
+Returns: The return type is specified as ``pandas.DataFrame``, with a clear explanation of the difference based on the ``return_df`` flag.  
+
+KDE Distribution Plots: Improved ``kde_distributions()`` with enhanced options for log scaling, mean/median plotting, custom standard deviation lines, and better handling of legends and scientific notation.  
+
+Scatter Plots: Enhanced ``scatter_fit_plot()`` with support for hue-based coloring, best fit lines, correlation display, and flexible grid plotting options.  
 
 
 `Version 0.0.8`_

diff --git a/docs/changelog.html b/docs/changelog.html
@@ -130,12 +130,19 @@ <h2><a class="reference external" href="./v0.0.9/index.html">Version 0.0.9</a><a
 <p><strong>Bug Fixes and Minor Improvements</strong></p>
 <p>Improved error messages and validation checks across multiple functions to prevent common pitfalls and ensure smoother user experience.</p>
 <p><strong>Visualization Enhancements</strong></p>
-<p>DataFrame Columns: Added a <code class="docutils literal notranslate"><span class="pre">background_color</span></code> variable to <code class="docutils literal notranslate"><span class="pre">dataframe_columns`</span></code>, allowing the user to enter a string representing a color name, or hex value. Try/Except on the output, in case the end user has a deprecated version of Pandas, where the styler would use <cite>hide()</cite> instead of <cite>hide_index()</cite>. The highlighted columns allow for easier null versus unique value analysis.</p>
-<p>The docstring now clearly describes the purpose of the function—analyzing DataFrame columns to provide summary statistics.</p>
-<p>Args:
-- The <code class="docutils literal notranslate"><span class="pre">df</span></code> argument is specified as a <code class="docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code>.
-- The <code class="docutils literal notranslate"><span class="pre">background_color</span></code> argument is marked as optional, with a brief description of its role.
-- The <code class="docutils literal notranslate"><span class="pre">return_df</span></code> argument is also marked as optional, explaining what it controls.</p>
+<p>DataFrame Columns: Added a <code class="docutils literal notranslate"><span class="pre">background_color</span></code> variable to <code class="docutils literal notranslate"><span class="pre">dataframe_columns`</span></code>,
+allowing the user to enter a string representing a color name, or hex value.
+Try/Except on the output, in case the end user has a deprecated version of Pandas,
+where the styler would use <code class="docutils literal notranslate"><span class="pre">hide()</span></code> instead of <code class="docutils literal notranslate"><span class="pre">hide_index()</span></code>. The highlighted
+columns allow for easier null versus unique value analysis.</p>
+<p>The docstring now clearly describes the purpose of the function—analyzing
+DataFrame columns to provide summary statistics.</p>
+<p>Args:</p>
+<ul class="simple">
+<li><p>The <code class="docutils literal notranslate"><span class="pre">df</span></code> argument is specified as a <code class="docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code>.</p></li>
+<li><p>The <code class="docutils literal notranslate"><span class="pre">background_color</span></code> argument is marked as optional, with a brief description of its role.</p></li>
+<li><p>The <code class="docutils literal notranslate"><span class="pre">return_df</span></code> argument is also marked as optional, explaining what it controls.</p></li>
+</ul>
 <p>Returns: The return type is specified as <code class="docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code>, with a clear explanation of the difference based on the <code class="docutils literal notranslate"><span class="pre">return_df</span></code> flag.</p>
 <p>KDE Distribution Plots: Improved <code class="docutils literal notranslate"><span class="pre">kde_distributions()</span></code> with enhanced options for log scaling, mean/median plotting, custom standard deviation lines, and better handling of legends and scientific notation.</p>
 <p>Scatter Plots: Enhanced <code class="docutils literal notranslate"><span class="pre">scatter_fit_plot()</span></code> with support for hue-based coloring, best fit lines, correlation display, and flexible grid plotting options.</p>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/v0.0.5/.buildinfo b/docs/v0.0.5/.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: 87a6c7f25fb604283522c5303a44bf8f
+config: b3c0c8d0d29ea2682212c0ffdc1df2ef
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/v0.0.5/.doctrees/acknowledgements.doctree b/docs/v0.0.5/.doctrees/acknowledgements.doctree
diff --git a/docs/v0.0.5/.doctrees/changelog.doctree b/docs/v0.0.5/.doctrees/changelog.doctree
diff --git a/docs/v0.0.5/.doctrees/citations.doctree b/docs/v0.0.5/.doctrees/citations.doctree
diff --git a/docs/v0.0.5/.doctrees/environment.pickle b/docs/v0.0.5/.doctrees/environment.pickle
diff --git a/docs/v0.0.5/.doctrees/getting_started.doctree b/docs/v0.0.5/.doctrees/getting_started.doctree
diff --git a/docs/v0.0.5/.doctrees/index.doctree b/docs/v0.0.5/.doctrees/index.doctree
diff --git a/docs/v0.0.5/.doctrees/references.doctree b/docs/v0.0.5/.doctrees/references.doctree
diff --git a/docs/v0.0.5/.doctrees/usage_guide.doctree b/docs/v0.0.5/.doctrees/usage_guide.doctree
diff --git a/docs/v0.0.6/.buildinfo b/docs/v0.0.6/.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: e06d1f58192f4e46a38de90cdf94a9de
+config: be47de5d43f2524b070390f19af79a4e
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/v0.0.6/.doctrees/acknowledgements.doctree b/docs/v0.0.6/.doctrees/acknowledgements.doctree
diff --git a/docs/v0.0.6/.doctrees/changelog.doctree b/docs/v0.0.6/.doctrees/changelog.doctree
diff --git a/docs/v0.0.6/.doctrees/citations.doctree b/docs/v0.0.6/.doctrees/citations.doctree
diff --git a/docs/v0.0.6/.doctrees/environment.pickle b/docs/v0.0.6/.doctrees/environment.pickle
diff --git a/docs/v0.0.6/.doctrees/getting_started.doctree b/docs/v0.0.6/.doctrees/getting_started.doctree
diff --git a/docs/v0.0.6/.doctrees/index.doctree b/docs/v0.0.6/.doctrees/index.doctree
diff --git a/docs/v0.0.6/.doctrees/references.doctree b/docs/v0.0.6/.doctrees/references.doctree
diff --git a/docs/v0.0.6/.doctrees/usage_guide.doctree b/docs/v0.0.6/.doctrees/usage_guide.doctree
diff --git a/docs/v0.0.7/.buildinfo b/docs/v0.0.7/.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: 386974e336f4c88c79e53569fd4f8edf
+config: ff9c8ab909180242ca4f3ee60c0a243e
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/v0.0.7/.doctrees/acknowledgements.doctree b/docs/v0.0.7/.doctrees/acknowledgements.doctree
diff --git a/docs/v0.0.7/.doctrees/changelog.doctree b/docs/v0.0.7/.doctrees/changelog.doctree
diff --git a/docs/v0.0.7/.doctrees/citations.doctree b/docs/v0.0.7/.doctrees/citations.doctree
diff --git a/docs/v0.0.7/.doctrees/contributors.doctree b/docs/v0.0.7/.doctrees/contributors.doctree
diff --git a/docs/v0.0.7/.doctrees/environment.pickle b/docs/v0.0.7/.doctrees/environment.pickle
diff --git a/docs/v0.0.7/.doctrees/getting_started.doctree b/docs/v0.0.7/.doctrees/getting_started.doctree
diff --git a/docs/v0.0.7/.doctrees/index.doctree b/docs/v0.0.7/.doctrees/index.doctree
diff --git a/docs/v0.0.7/.doctrees/references.doctree b/docs/v0.0.7/.doctrees/references.doctree
diff --git a/docs/v0.0.7/.doctrees/usage_guide.doctree b/docs/v0.0.7/.doctrees/usage_guide.doctree
diff --git a/docs/v0.0.8/.buildinfo b/docs/v0.0.8/.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: 32bf76bba4b673dae9ce3d78550d9c4a
+config: 76b948f4279c755a634ebf8f03f2c634
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/v0.0.8/.doctrees/acknowledgements.doctree b/docs/v0.0.8/.doctrees/acknowledgements.doctree
diff --git a/docs/v0.0.8/.doctrees/changelog.doctree b/docs/v0.0.8/.doctrees/changelog.doctree
diff --git a/docs/v0.0.8/.doctrees/citations.doctree b/docs/v0.0.8/.doctrees/citations.doctree
diff --git a/docs/v0.0.8/.doctrees/contributors.doctree b/docs/v0.0.8/.doctrees/contributors.doctree
diff --git a/docs/v0.0.8/.doctrees/environment.pickle b/docs/v0.0.8/.doctrees/environment.pickle
diff --git a/docs/v0.0.8/.doctrees/getting_started.doctree b/docs/v0.0.8/.doctrees/getting_started.doctree
diff --git a/docs/v0.0.8/.doctrees/index.doctree b/docs/v0.0.8/.doctrees/index.doctree
diff --git a/docs/v0.0.8/.doctrees/references.doctree b/docs/v0.0.8/.doctrees/references.doctree
diff --git a/docs/v0.0.8/.doctrees/usage_guide.doctree b/docs/v0.0.8/.doctrees/usage_guide.doctree
diff --git a/docs/v0.0.9/.buildinfo b/docs/v0.0.9/.buildinfo
@@ -0,0 +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: b4ce0fd18cca7186c233d8ea36563eed
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/v0.0.9/.doctrees/acknowledgements.doctree b/docs/v0.0.9/.doctrees/acknowledgements.doctree
diff --git a/docs/v0.0.9/.doctrees/changelog.doctree b/docs/v0.0.9/.doctrees/changelog.doctree
diff --git a/docs/v0.0.9/.doctrees/citations.doctree b/docs/v0.0.9/.doctrees/citations.doctree
diff --git a/docs/v0.0.9/.doctrees/contributors.doctree b/docs/v0.0.9/.doctrees/contributors.doctree
diff --git a/docs/v0.0.9/.doctrees/data_management.doctree b/docs/v0.0.9/.doctrees/data_management.doctree
diff --git a/docs/v0.0.9/.doctrees/eda_plots.doctree b/docs/v0.0.9/.doctrees/eda_plots.doctree
diff --git a/docs/v0.0.9/.doctrees/environment.pickle b/docs/v0.0.9/.doctrees/environment.pickle
diff --git a/docs/v0.0.9/.doctrees/getting_started.doctree b/docs/v0.0.9/.doctrees/getting_started.doctree
diff --git a/docs/v0.0.9/.doctrees/index.doctree b/docs/v0.0.9/.doctrees/index.doctree
diff --git a/docs/v0.0.9/.doctrees/references.doctree b/docs/v0.0.9/.doctrees/references.doctree
diff --git a/docs/v0.0.9/3d_pdp.html b/docs/v0.0.9/3d_pdp.html