Fix descriptions and docstrings (#6)

Fix docstrings & description
bnelair · Jul 5, 2024 · c688138 · c688138
1 parent 2c8adb7
commit c688138
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/best/feature_extraction/WaveDetector.py b/best/feature_extraction/WaveDetector.py
@@ -9,6 +9,8 @@
 import numpy as np
 from copy import deepcopy
 from best.signal import LowFrequencyFilter, fft_filter
+import os
+import matplotlib.pyplot as plt
 
 class WaveDetector:
     """

diff --git a/projects/slow_wave_detection/readme.rst b/projects/slow_wave_detection/readme.rst
@@ -7,9 +7,9 @@ Here we conveniently provide a standalone fully functional code example for anal
 This enables trialing this code without installing the whole Best Toolbox library.
 The codes were also embedded in the BEST Toolbox so they can be freely available upon installing the whole `BEST Toolbox <https://github.com/bnelair/best-toolbox>`_ library.
 
-The documentation to the toolbox is available at
+The documentation to the toolbox is available at `BEST Toolbox docs <https://best-toolbox.readthedocs.io/en/latest/>`_.
 
-For more information on this specific project, see the page describing `Wave Detection <https://best-toolbox.readthedocs.io/en/latest/>`_.
+For more information on this specific project, see the page describing `Wave Detection <https://best-toolbox.readthedocs.io/en/latest/feature_extraction.WaveDetector.html>`_.
 
 
 Acknowledgement