ridgeplot-py 0.2.5__tar.gz → 0.2.7__tar.gz

{ridgeplot_py-0.2.5 → ridgeplot_py-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ridgeplot-py
-Version: 0.2.5
+Version: 0.2.7
 Summary: Plotting ridgeplots with matplotlib
 License: MIT
 Author: Douglas Wu

{ridgeplot_py-0.2.5 → ridgeplot_py-0.2.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ridgeplot-py"
-version = "0.2.5"                                   # managed by poetry-dynamic-versioning
+version = "0.2.7"                                   # managed by poetry-dynamic-versioning
 description = "Plotting ridgeplots with matplotlib"
 authors = ["Douglas Wu <wckdouglas@gmail.com>"]
 license = "MIT"

{ridgeplot_py-0.2.5 → ridgeplot_py-0.2.7}/ridgeplot/colors.py

@@ -141,6 +141,7 @@ class ColorEncoder:
 
     Example:
         ```
+        >>> from ridgeplot.colors import ColorEncoder, ColorPalette
         >>> categorical_vector = ['group a','group b','group c','group a']
         >>> colors = ColorPalette["okabeito"]
         >>> ce = ColorEncoder()
@@ -279,8 +280,11 @@ def get_cmap_color_values(cmap_name: str) -> Tuple[str, str]:
     """
     Get color values for the min and max color in a color map
 
-    :param str cmap_name: color map name (e.g. viridis)
-    :return Tuple[str, str]: hex code for the min and max color
+    Args:
+        cmap_name: color map name (e.g. viridis)
+
+    Returns:
+        hex code for the min and max color
     """
     cmap = get_cmap(cmap_name)
     return to_hex(cmap(0.0)), to_hex(cmap(1.0))

{ridgeplot_py-0.2.5 → ridgeplot_py-0.2.7}/ridgeplot/dotted_heatmap.py

@@ -26,6 +26,7 @@ def dotted_heatmap(
     Example:
         ```
         >>> import matplotlib.pyplot as plt
+        >>> from ridgeplot.dotted_heatmap import dotted_heatmap
         >>> fig = plt.figure()
         >>> ax = fig.add_subplot(111)
         >>> data = pd.DataFrame(
@@ -36,11 +37,12 @@ def dotted_heatmap(
         >>> dotted_heatmap(data=data,ax=ax, cmap="viridis")
         ```
 
-    :param pd.DataFrame data: data to plot
-    :param matplotlib.axes ax: matplotlib ax object
-    :param str cmap: cmap value, defaults to "cividis"
-    :param Optional[float] circle_size: raidus of the circles,
-        if None, we will use relaive sizes, defaults to None
+    Args:
+        data: data to plot
+        ax: matplotlib ax object
+        cmap: cmap value, defaults to "cividis"
+        circle_size: raidus of the circles,
+            if None, we will use relaive sizes, defaults to None
     """
     nrows, ncols = data.shape
     x, y = np.meshgrid(np.arange(ncols), np.arange(nrows))
@@ -64,5 +66,4 @@ def dotted_heatmap(
     ax.tick_params(left=False, bottom=False)
     for d in ["top", "bottom", "left", "right"]:
         ax.spines[d].set(alpha=0.5)
-    cbar = plt.colorbar(col)
-    return cbar
+    plt.colorbar(col)

{ridgeplot_py-0.2.5 → ridgeplot_py-0.2.7}/ridgeplot/ridge_plot.py

@@ -34,6 +34,7 @@ def ridgeplot(
         ```
         >>> import numpy as np
         >>> import matplotlib.pyplot as plt
+        >>> from ridgeplot.ridge_plot import ridgeplot
 
         >>> data = {}
         >>> for i in range(10):