Skip to content

Commit

Permalink
updated verison 0.09 with proper args in changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
lshpaner committed Sep 17, 2024
1 parent 5e39945 commit f5ffd26
Show file tree
Hide file tree
Showing 51 changed files with 35 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/v0.0.5/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: b3c0c8d0d29ea2682212c0ffdc1df2ef
config: 1b1adf592aabc8db8c151cf1f350e9c7
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/v0.0.5/.doctrees/acknowledgements.doctree
Binary file not shown.
Binary file modified docs/v0.0.5/.doctrees/changelog.doctree
Binary file not shown.
Binary file modified docs/v0.0.5/.doctrees/citations.doctree
Binary file not shown.
Binary file modified docs/v0.0.5/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/v0.0.5/.doctrees/getting_started.doctree
Binary file not shown.
Binary file modified docs/v0.0.5/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/v0.0.5/.doctrees/references.doctree
Binary file not shown.
Binary file modified docs/v0.0.5/.doctrees/usage_guide.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/v0.0.6/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: be47de5d43f2524b070390f19af79a4e
config: 60be3e2a88935ae62d8f0e0d04c41ddb
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/v0.0.6/.doctrees/acknowledgements.doctree
Binary file not shown.
Binary file modified docs/v0.0.6/.doctrees/changelog.doctree
Binary file not shown.
Binary file modified docs/v0.0.6/.doctrees/citations.doctree
Binary file not shown.
Binary file modified docs/v0.0.6/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/v0.0.6/.doctrees/getting_started.doctree
Binary file not shown.
Binary file modified docs/v0.0.6/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/v0.0.6/.doctrees/references.doctree
Binary file not shown.
Binary file modified docs/v0.0.6/.doctrees/usage_guide.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/v0.0.7/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: ff9c8ab909180242ca4f3ee60c0a243e
config: 50986ddd40a23ca171a83426287f7282
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/v0.0.7/.doctrees/acknowledgements.doctree
Binary file not shown.
Binary file modified docs/v0.0.7/.doctrees/changelog.doctree
Binary file not shown.
Binary file modified docs/v0.0.7/.doctrees/citations.doctree
Binary file not shown.
Binary file modified docs/v0.0.7/.doctrees/contributors.doctree
Binary file not shown.
Binary file modified docs/v0.0.7/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/v0.0.7/.doctrees/getting_started.doctree
Binary file not shown.
Binary file modified docs/v0.0.7/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/v0.0.7/.doctrees/references.doctree
Binary file not shown.
Binary file modified docs/v0.0.7/.doctrees/usage_guide.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/v0.0.8/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: 76b948f4279c755a634ebf8f03f2c634
config: fb358438d45846fc8c555a18b2b1819b
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/v0.0.8/.doctrees/acknowledgements.doctree
Binary file not shown.
Binary file modified docs/v0.0.8/.doctrees/changelog.doctree
Binary file not shown.
Binary file modified docs/v0.0.8/.doctrees/citations.doctree
Binary file not shown.
Binary file modified docs/v0.0.8/.doctrees/contributors.doctree
Binary file not shown.
Binary file modified docs/v0.0.8/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/v0.0.8/.doctrees/getting_started.doctree
Binary file not shown.
Binary file modified docs/v0.0.8/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/v0.0.8/.doctrees/references.doctree
Binary file not shown.
Binary file modified docs/v0.0.8/.doctrees/usage_guide.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/v0.0.9/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: b4ce0fd18cca7186c233d8ea36563eed
config: a7cb7a947a3651bcecc113592ff0f0c4
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/v0.0.9/.doctrees/acknowledgements.doctree
Binary file not shown.
Binary file modified docs/v0.0.9/.doctrees/changelog.doctree
Binary file not shown.
Binary file modified docs/v0.0.9/.doctrees/citations.doctree
Binary file not shown.
Binary file modified docs/v0.0.9/.doctrees/contributors.doctree
Binary file not shown.
Binary file modified docs/v0.0.9/.doctrees/data_management.doctree
Binary file not shown.
Binary file modified docs/v0.0.9/.doctrees/eda_plots.doctree
Binary file not shown.
Binary file modified docs/v0.0.9/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/v0.0.9/.doctrees/getting_started.doctree
Binary file not shown.
Binary file modified docs/v0.0.9/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/v0.0.9/.doctrees/references.doctree
Binary file not shown.
25 changes: 17 additions & 8 deletions docs/v0.0.9/_sources/changelog.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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`_
Expand Down
19 changes: 13 additions & 6 deletions docs/v0.0.9/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit f5ffd26

Please sign in to comment.