Skip to content

Commit 2a75b21

Browse files
committed
update readme and version string
1 parent 8667ccb commit 2a75b21

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

README.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -335,27 +335,28 @@ Input Arguments:
335335
- ``recordname`` (required): The string name of the WFDB record to be written (without any file extensions).
336336
- ``extension`` (required): The string annotation file extension.
337337
- ``sample`` (required): The annotation location in samples relative to the beginning of the record. Numpy array.
338-
- ``symbol (default=None): The symbols used to display the annotation labels. List or numpy array. If this field
339-
is present, 'label_store' must not be present.
338+
- ``symbol`` (default=None): The symbols used to display the annotation labels. List or numpy array. If this field is present, 'label_store' must not be present.
340339
- ``subtype`` (default=None): The marked class/category of each annotation. Numpy array.
341-
- ``chan (default=None): The signal channel associated with each annotation. Numpy array.
342-
- ``num ``(default=None): The labelled annotation number of each annotation. Numpy array.
340+
- ``chan`` (default=None): The signal channel associated with each annotation. Numpy array.
341+
- ``num`` (default=None): The labelled annotation number of each annotation. Numpy array.
343342
- ``aux_note`` (default=None): The auxiliary information strings. List or numpy array.
344-
- ``label_store`` (default=None): The integer values used to store the annotation labels. Numpy array.
345-
If this field is present, 'symbol' must not be present.
343+
- ``label_store`` (default=None): The integer values used to store the annotation labels. Numpy array. If this field is present, 'symbol' must not be present.
346344
- ``fs`` (default=None): The numerical sampling frequency of the record to be written to the file.
347-
- ``custom_labels`` (default=None): The map of custom defined annotation labels used for this annotation, in
348-
addition to the standard WFDB annotation labels. The custom labels are defined by two or three fields:
345+
- ``custom_labels`` (default=None): The map of custom defined annotation labels used for this annotation, in addition to the standard WFDB annotation labels. The custom labels are defined by two or three fields:
346+
349347
- The integer values used to store custom annotation labels in the file (optional)
350348
- Their short display symbols
351349
- Their long descriptions.
350+
352351
This input argument may come in four formats:
352+
353353
1. A pandas.DataFrame object with columns: ['label_store', 'symbol', 'description']
354354
2. A pandas.DataFrame object with columns: ['symbol', 'description']
355355
If this option is chosen, label_store values are automatically chosen.
356356
3. A list or tuple of tuple triplets, with triplet elements representing: (label_store, symbol, description).
357357
4. A list or tuple of tuple pairs, with pair elements representing: (symbol, description).
358358
If this option is chosen, label_store values are automatically chosen.
359+
359360
If the 'label_store' field is given for this function, and 'custom_labels' is defined, 'custom_labels'
360361
must contain 'label_store' in its mapping. ie. it must come in format 1 or 3 above.
361362

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
# Versions should comply with PEP440. For a discussion on single-sourcing
2121
# the version across setup.py and the project code, see
2222
# https://packaging.python.org/en/latest/single_source_version.html
23-
version='1.2.2',
23+
version='1.3.0',
2424

2525
description='The WFDB Python Toolbox',
2626
long_description=long_description,

0 commit comments

Comments
 (0)