Improved documentation for the win_length parameter

Author: claudiodsf

CHANGELOG.md

@@ -56,6 +56,7 @@ Copyright (c) 2011-2025 Claudio Satriano <satriano@ipgp.fr>
 
 ### Config file
 
+- Improved documentation for the `win_length` parameter
 - New option `r_power_n_segmented` for the `geom_spread_model` config parameter
 - New config parameters: `geom_spread_n_exponents`, `geom_spread_n_distances`
 - New config parameters: `refine_theoretical_arrivals`, `autopick_freqmin`,

sourcespec/config_files/configspec.conf

@@ -146,7 +146,16 @@ noise_pre_time = float(min=0.01, default=6.0)
 # times (see "wave_type" below)
 signal_pre_time = float(default=1.0)
 
-# Length (in seconds) for both noise and signal windows
+# Length (in seconds) for both noise and signal windows.
+# Notes:
+# 1. If the weighting mode is 'noise' (see INVERSION PARAMETERS below)
+#    and the trace starts too late to include the full noise window,
+#    the noise window will be shortened to fit the available data,
+#    and the signal window will be truncated to match the shortened
+#    noise window length.
+# 2. If the weighting mode is 'inv_frequency' (see INVERSION PARAMETERS below)
+#    and the trace starts too late to include the full noise window,
+#    the noise window will be zero-padded to match the signal window length.
 win_length = float(min=0, default=5.0)
 # Variable window length factor (fraction of travel time):
 #   win_length = max(win_length, variable_win_length_factor * travel_time)