Merge branch 'main' into dependabot/github_actions/actions/upload-art…

…ifact-4.3.0

LICENSES_bundled.txt

@@ -1,30 +1,38 @@
 NumPy:
   name: numpy
-  version: 1.26.1
+  version: 1.26.2
   license: BSD 3-Clause "New" or "Revised" License
   repository: https://github.com/numpy/numpy
   homepage: https://numpy.org/
   dependency: production
 
 SciPy
   name: scipy
-  version: 1.11.3
+  version: 1.11.4
   license: BSD 3-Clause "New" or "Revised" License
   repository: https://github.com/scipy/scipy
   homepage: https://scipy.org/
   dependency: production
 
+Poetry
+  name: poetry
+  version: 1.6.1
+  license: The MIT License
+  repository: https://github.com/python-poetry/poetry
+  homepage: https://python-poetry.org/
+  dependency: dev
+
 MyPy
   name: mypy
-  version: 1.6.1
+  version: 1.7.1
   license: The MIT License
   repository: https://github.com/python/mypy
   homepage: https://www.mypy-lang.org/
   dependency: dev
 
 Ruff
   name: ruff
-  version: 0.1.5
+  version: 0.1.8
   license: The MIT license 
   repository: https://github.com/astral-sh/ruff
   homepage: https://docs.astral.sh/ruff/

README.md

@@ -79,7 +79,9 @@
 
 ## Installation
 
-`pip install obscure_stats`
+```bash
+>>> pip install obscure_stats
+```
 
 ## Usage Example
 

src/obscure_stats/skewness/skewness.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import numpy as np
-from scipy import special, stats  # type: ignore[import-untyped]
+from scipy import integrate, special, stats  # type: ignore[import-untyped]
 
 from obscure_stats.central_tendency import half_sample_mode
 
@@ -83,7 +83,7 @@ def bickel_mode_skew(x: np.ndarray) -> float:
 
     Returns
     -------
-    phmods : float
+    bms : float
         The value of Bickel's mode skew coefficient.
 
     References
@@ -304,7 +304,7 @@ def _auc_skew_gamma(x: np.ndarray, dp: float, w: np.ndarray | float) -> float:
     qs_low = qs[:half_n]
     qs_high = qs[-half_n:]
     skews = (qs_low + qs_high - 2 * med) / (qs_high - qs_low) * w
-    return np.trapz(skews, dx=dp)
+    return integrate.trapezoid(skews, dx=dp)
 
 
 def auc_skew_gamma(x: np.ndarray, dp: float = 0.01) -> float:
@@ -351,7 +351,7 @@ def wauc_skew_gamma(x: np.ndarray, dp: float = 0.01) -> float:
 
     Returns
     -------
-    aucbs : float
+    waucbs : float
         The value of weighted AUC Bowley skewness.
 
     References
@@ -379,7 +379,7 @@ def cumulative_skew(x: np.ndarray) -> float:
 
     Returns
     -------
-    cs : float
+    csc : float
         The value of cumulative skew.
 
     References