Hack macro-scoping into crate::signal for get_window

Utilise `#[doc(inline)]` and `#[doc(never)]` to hide name from crate
root and show up in `::signal` namespace instead.

Author: SpookyYomo

sci-rs/src/signal/mod.rs

@@ -24,6 +24,18 @@ pub mod convolve;
 /// namespace is located here.
 pub mod windows;
 
+// Convenience macro for down-stream users
+/// This provides the same convenience function as in the scipy.signal namespace. Returns a window
+/// of given length and type.
+///
+/// # Parameters:
+/// - `window`: The type of window to create.  
+/// - `m`: Number of samples in the window.  
+/// - `fftbins`: If true (default), creates a "periodic" window, ready to use with ifftshift and be
+///   multiplied by the result of an FFT. If False, create a "symmetric" window, for use in filter design.
+#[doc(inline)]
+pub use crate::_signal_windows_getWindow as get_window;
+
 /// Signal Resampling  
 /// This contains only the
 /// [`resample`](https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.resample.html#scipy.signal.resample)

sci-rs/src/signal/windows/mod.rs

@@ -338,13 +338,16 @@ where
 /// of given length and type.
 ///
 /// # Parameters:
-/// - window: The type of window to create.  
-/// - m: Number of samples in the window.  
-/// - fftbins: If true (default), creates a "periodic" window, ready to use with ifftshift and be
+/// - `window`: The type of window to create.  
+/// - `m`: Number of samples in the window.  
+/// - `fftbins`: If true (default), creates a "periodic" window, ready to use with ifftshift and be
 ///   multiplied by the result of an FFT. If False, create a "symmetric" window, for use in filter design.
 // #[cfg(feature = "std")]
+/// Documentation is provided only at the public point of the interface. It is mangled here to
+/// provide scoping.
+#[doc(hidden)]
 #[macro_export]
-macro_rules! get_window {
+macro_rules! _signal_windows_getWindow {
     // Parameterized windows (tuple form with sym)
     ( ("kaiser", $beta:expr), $m:expr, $sym:expr ) => {
         $crate::signal::windows::Kaiser::new($m, $beta, !$sym).get_window()

sci-rs/src/signal/windows/triangle.rs

@@ -66,7 +66,7 @@ where
     /// (`std` feature is required for macros.)
     /// #[cfg(feature = "std")]
     /// ```
-    /// use sci_rs::get_window;
+    /// use sci_rs::signal::get_window;
     /// use sci_rs::signal::windows::GetWindow;
     /// let actual = get_window!("triangle", 8);
     /// assert_eq!(vec![0.125, 0.375, 0.625, 0.875, 0.875, 0.625, 0.375, 0.125], actual);
@@ -209,7 +209,7 @@ mod tests {
     #[test]
     #[cfg(feature = "std")]
     fn from_macro() {
-        use crate::get_window;
+        use crate::signal::get_window;
 
         let actual = get_window!("triangle", 8);
         assert_eq!(