Skip to content

Clarify expanded signal format in docstrings #556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
briangow merged 1 commit into from
Jan 9, 2026
Merged

Clarify expanded signal format in docstrings #556

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions wfdb/io/record.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -712,11 +712,9 @@ class Record(BaseRecord, _header.HeaderMixin, _signal.SignalMixin):
must be set, but not both. In addition, if d_signal is set, fmt, gain
and baseline must also all be set.
e_p_signal : ndarray, optional
The expanded physical conversion of the signal. Either a 2d numpy
array or a list of 1d numpy arrays.
The expanded physical conversion of the signal as a list of 1d numpy arrays.
e_d_signal : ndarray, optional
The expanded digital conversion of the signal. Either a 2d numpy
array or a list of 1d numpy arrays.
The expanded digital conversion of the signal as a list of 1d numpy arrays.
record_name : str, optional
The name of the WFDB record to be read, without any file
extensions. If the argument contains any path delimiter
Expand Down Expand Up @@ -2892,11 +2890,9 @@ def wrsamp(
must be set, but not both. In addition, if d_signal is set, fmt, gain
and baseline must also all be set.
e_p_signal : ndarray, optional
The expanded physical conversion of the signal. Either a 2d numpy
array or a list of 1d numpy arrays.
The expanded physical conversion of the signal as a list of 1d numpy arrays.
e_d_signal : ndarray, optional
The expanded digital conversion of the signal. Either a 2d numpy
array or a list of 1d numpy arrays.
The expanded digital conversion of the signal as a list of 1d numpy arrays.
samps_per_frame : int or list of ints, optional
The total number of samples per frame.
fmt : list, optional
Expand Down