From 4084c079e68d86766c33a48a49ee4ef0c75e507e Mon Sep 17 00:00:00 2001 From: Clemens Brunner Date: Tue, 10 Dec 2024 11:41:45 +0100 Subject: [PATCH] Clearer docstring --- mne/io/base.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mne/io/base.py b/mne/io/base.py index 78168924029..a6b60bd386f 100644 --- a/mne/io/base.py +++ b/mne/io/base.py @@ -1507,10 +1507,10 @@ def rescale(self, scale, *, verbose=None): Parameters ---------- scale : int | float | dict - The scaling factor to apply. If a float, the same scaling factor is applied - to all channels (this works only if all channels are of the same type). If a - dict, the keys must be valid channel types and the values the scaling - factors to apply to the corresponding channels. + The scaling factor by which to multiply the data. If a float, the same + scaling factor is applied to all channels (this works only if all channels + are of the same type). If a dict, the keys must be valid channel types and + the values the scaling factors to apply to the corresponding channels. %(verbose)s Returns