Rafactor/reofrmat all modules (#112)

chore(docs): fix examples and formatting across modules, update doctest and CI hooks

- Fixed outdated examples and docstrings in multiple modules (e.g., descriptors, sensitivity, tools)
- Enabled `nbval` testing for the `docs/` directory and adjusted test hooks accordingly
- Added Rhine example and updated plotting behavior for conditional checks
- Addressed minor validation issues (e.g., `alpha` and `scale` checks)
- Updated pre-commit hook configuration and excluded notebooks from `detect-secrets`

Author: MAfarrag

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
         args: [ --markdown-linebreak-ext=md ]
       - id: check-added-large-files
         name: "[file -  check] large file"
-        args: [ --maxkb=2000 ]
+        args: [ --maxkb=3000 ]
       - id: check-docstring-first
         name: "[py   -  check] docstring first"
         files: /examples
@@ -119,6 +119,7 @@ repos:
     rev: v1.5.0
     hooks:
       - id: detect-secrets
+        exclude: \.ipynb$
   - repo: https://github.com/bridgecrewio/checkov
     rev: 3.2.416
     hooks:
@@ -157,7 +158,7 @@ repos:
     hooks:
       - id: notebook-check
         name: nbval
-        entry: pytest --nbval-lax
+        entry: pytest --nbval-lax docs
         language: system
         files: \.ipynb$
         always_run: true
@@ -166,7 +167,6 @@ repos:
     hooks:
       - id: doctest
         name: doctest
-        entry: python -c "import matplotlib; matplotlib.use('Agg'); import pytest; pytest.main(['--doctest-modules'])"
+        entry: python -c "import matplotlib; matplotlib.use('Agg'); import pytest; import sys; sys.exit(pytest.main(['--doctest-modules', 'src']))"
         language: system
-        files: ^src/statista/.*\.py$
         always_run: true

README.md

@@ -128,7 +128,7 @@ This project is licensed under the GPL-3.0 License - see the LICENSE file for de
 If you use Statista in your research, please cite it as:
 
 ```
-Farrag, M. (2023). Statista: A Python package for statistical analysis, extreme value analysis, and sensitivity analysis. 
+Farrag, M. (2023). Statista: A Python package for statistical analysis, extreme value analysis, and sensitivity analysis.
 https://github.com/Serapieum-of-alex/statista
 ```
 

docs/_images/expo-random-cdf.png …images/distributions/expo-random-cdf.pngdocs/_images/expo-random-cdf.png renamed to docs/_images/distributions/expo-random-cdf.png docs/_images/expo-random-cdf.png renamed to docs/_images/distributions/expo-random-cdf.png

@@ -128,7 +128,7 @@ This project is licensed under the GPL-3.0 License - see the LICENSE file for de
 If you use Statista in your research, please cite it as:
 
 ```
-Farrag, M. (2023). Statista: A Python package for statistical analysis, extreme value analysis, and sensitivity analysis. 
+Farrag, M. (2023). Statista: A Python package for statistical analysis, extreme value analysis, and sensitivity analysis.
 https://github.com/Serapieum-of-alex/statista
 ```