From a8d85cbb34208a0ba30facc01d9b13dea9fc30f8 Mon Sep 17 00:00:00 2001 From: Matt Fay Date: Wed, 23 Aug 2023 20:17:04 -0400 Subject: [PATCH] Add versionadded to the newly added parts of the interface --- src/pysparkplug/__init__.py | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/src/pysparkplug/__init__.py b/src/pysparkplug/__init__.py index 2b16282..2e39568 100644 --- a/src/pysparkplug/__init__.py +++ b/src/pysparkplug/__init__.py @@ -15,16 +15,22 @@ from pysparkplug._version import __version__ as __version__ SINGLE_LEVEL_WILDCARD = _constants.SINGLE_LEVEL_WILDCARD -"""Constant for single-level MQTT topic wildcard, -with type annotation for compatibility with pysparkplug interfaces +"""Constant for single-level MQTT topic wildcard + +Uses type annotation for compatibility with `Topic` objects. + +.. versionadded:: 0.2.0 """ MULTI_LEVEL_WILDCARD = _constants.MULTI_LEVEL_WILDCARD -"""Constant for multi-level MQTT topic wildcard, -with type annotation for compatibility with pysparkplug interfaces +"""Constant for multi-level MQTT topic wildcard + +Uses type annotation for compatibility with `Topic` objects. + +.. versionadded:: 0.2.0 """ MetricValue = _types.MetricValue -"""Type annotation for the types a Sparkplug B metric's `value` attribute can take""" +"""Type annotation for the types a `Metric`'s `value` attribute can take""" del _constants, _types