diff --git a/docs/source/development.md b/docs/source/development.md index baeb1fa..08a609f 100644 --- a/docs/source/development.md +++ b/docs/source/development.md @@ -15,3 +15,10 @@ uv run pytest We use [`ruff`](https://docs.astral.sh/ruff/) for linting and formatting the code base, and [semantic versioning](https://semver.org/) for the release tags. + + +## Changelog + +A detailed changelog summarizing all changes incorporated in vitabel between +releases can be found at the +[GitHub Release Overview](https://github.com/UniGrazMath/vitabel/releases). \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 6b9ef29..cf831df 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "vitabel" -version = "0.0.1" +version = "0.1.0" description = "A toolbox for plotting and interactively labeling vital data." authors = [ {name = "Wolfgang J. Kern", email = "wolfgangjohannkern@gmail.com"}, diff --git a/src/vitabel/timeseries.py b/src/vitabel/timeseries.py index 7735043..eedd4b3 100644 --- a/src/vitabel/timeseries.py +++ b/src/vitabel/timeseries.py @@ -964,10 +964,10 @@ class Label(TimeSeriesBase): When plotting label data using vertical lines, this argument controls how text labels for the lines are determined. Available options are: - - ``'text_data'``: Uses strings from :attr:`.text_data` as line labels. + - ``'text_data'``: Uses strings from :attr:`text_data` as line labels. - ``'data'``: Uses string representations of the numeric :attr:`.data` values as line labels. - - ``'combined'``: Uses texts from :attr:`.text_data` where available and + - ``'combined'``: Uses texts from :attr:`text_data` where available and fills the rest with entries from :attr:`.data`. - ``'disabled'``: No text is shown next to the vertical lines. @@ -1310,7 +1310,7 @@ def add_data( The value of the data point. If not specified, the value is set to ``numpy.nan``. text - The string to be inserted into :attr:`.text_data`. + The string to be inserted into :attr:`.Label.text_data`. """ # check corner case first: is label empty and passed time absolute? if self.is_empty() and isinstance(time_data, Timestamp): @@ -2142,7 +2142,7 @@ def add_data( The numeric value of the data point. If not specified, the value is set to ``numpy.nan``. text - The string to be inserted into :attr:`.text_data`. + The string to be inserted into :attr:`text_data`. """ interval_start, interval_end = time_data if self.is_empty() and isinstance(interval_start, Timestamp): diff --git a/src/vitabel/vitals.py b/src/vitabel/vitals.py index 8a39c62..7e1fb02 100644 --- a/src/vitabel/vitals.py +++ b/src/vitabel/vitals.py @@ -1279,15 +1279,15 @@ def get_label_infos(self, **kwargs) -> pd.DataFrame: return _timeseries_list_info(self.get_labels(**kwargs)) def info(self, **kwargs) -> None: - """Displays relevant information about the channels and labels + """Display relevant information about the channels and labels currently present in the recording in two separate - ``pandas.DataFrame``s. + ``pandas.DataFrame`` objects. Parameters ---------- kwargs Keyword arguments to filter the channels and labels by. - See :meth:`.get_channel` and :meth:`.get_label` for valid + See :meth:`.get_channels` and :meth:`.get_labels` for valid specifications. Returns