Skip to content

Commit f4ada09

Browse files
authored
Merge pull request MIT-LCP#207 from MIT-LCP/add_doc_103
Improves documentation MIT-LCP#103
2 parents f69c7df + 8c7961a commit f4ada09

File tree

17 files changed

+2464
-727
lines changed

17 files changed

+2464
-727
lines changed

demo.ipynb

Lines changed: 54 additions & 61 deletions
Large diffs are not rendered by default.

docs/conf.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env python3
22
# -*- coding: utf-8 -*-
33
#
4-
# wfdb documentation build configuration file, created by
4+
# WFDB documentation build configuration file, created by
55
# sphinx-quickstart on Tue Jan 2 13:19:02 2018.
66
#
77
# This file is execfile()d with the current directory set to its
@@ -42,8 +42,7 @@ def __getattr__(cls, name):
4242
# Add any Sphinx extension module names here, as strings. They can be
4343
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
4444
# ones.
45-
extensions = ['sphinx.ext.autodoc',
46-
'numpydoc']
45+
extensions = ['sphinx.ext.autodoc']
4746

4847
# Add any paths that contain templates here, relative to this directory.
4948
templates_path = ['_templates']

tests/test_annotation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
class test_annotation():
88
"""
9-
Testing read and write of wfdb annotations, including Physionet
9+
Testing read and write of WFDB annotations, including Physionet
1010
streaming.
1111
1212
Target files created using the original WFDB Software Package

tests/test_processing.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,11 @@ def test_correct_peaks(self):
102102

103103
class test_qrs():
104104
"""
105-
Testing qrs detectors
105+
Testing QRS detectors
106106
"""
107107
def test_xqrs(self):
108108
"""
109-
Run xqrs detector on record 100 and compare to reference annotations
109+
Run XQRS detector on record 100 and compare to reference annotations
110110
"""
111111
sig, fields = wfdb.rdsamp('sample-data/100', channels=[0])
112112
ann_ref = wfdb.rdann('sample-data/100','atr')

tests/test_record.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
class TestRecord(unittest.TestCase):
1111
"""
12-
Test read and write of single segment wfdb records, including
12+
Test read and write of single segment WFDB records, including
1313
Physionet streaming.
1414
1515
Target files created using the original WFDB Software Package
@@ -429,7 +429,7 @@ def tearDownClass(cls):
429429

430430
class TestMultiRecord(unittest.TestCase):
431431
"""
432-
Test read and write of multi segment wfdb records, including
432+
Test read and write of multi segment WFDB records, including
433433
Physionet streaming.
434434
435435
Target files created using the original WFDB Software Package
@@ -521,7 +521,7 @@ def test_multi_variable_c(self):
521521
Multi-segment, variable layout, entire signal, physical
522522
523523
The reference signal creation cannot be made with rdsamp
524-
directly because the wfdb c package (10.5.24) applies the single
524+
directly because the WFDB c package (10.5.24) applies the single
525525
adcgain and baseline values from the layout specification
526526
header, which is undesired in multi-segment signals with
527527
different adcgain/baseline values across segments.

0 commit comments

Comments
 (0)