Skip to content

Commit

Permalink
Add versionadded to the newly added parts of the interface
Browse files Browse the repository at this point in the history
  • Loading branch information
matteosox committed Aug 24, 2023
1 parent 16570fb commit a8d85cb
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions src/pysparkplug/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit a8d85cb

Please sign in to comment.