class Delta(Type):
- _toSchema = {'deltas': 'Deltas'}
- _toPy = {'Deltas': 'deltas'}
+ """A single websocket delta.
+
+ :ivar entity: The entity name, e.g. 'unit', 'application'
+ :vartype entity: str
+
+ :ivar type: The delta type, e.g. 'add', 'change', 'remove'
+ :vartype type: str
+
+ :ivar data: The raw delta data
+ :vartype data: dict
+
+ NOTE: The 'data' variable above is being incorrectly cross-linked by a
+ Sphinx bug: https://github.com/sphinx-doc/sphinx/issues/2549
+
+ """
+ _toSchema = {'deltas': 'deltas'}
+ _toPy = {'deltas': 'deltas'}
def __init__(self, deltas=None):
- '''
- deltas : [str, str, object]
- '''
+ """
+ :param deltas: [str, str, object]
+
+ """
self.deltas = deltas
Change = namedtuple('Change', 'entity type data')