X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=juju%2Fclient%2Foverrides.py;h=3f3caa45576e60dde1853822477741fe4a88a30d;hb=5cf8d29d1ec5ff9360920dd831ff6ead145e3d11;hp=6ce2ee1866463b550cf720040c6b4b3ceb05202c;hpb=fe2d2f1a5ef2453359858481929a2526ea1a3c5c;p=osm%2FN2VC.git diff --git a/juju/client/overrides.py b/juju/client/overrides.py index 6ce2ee1..3f3caa4 100644 --- a/juju/client/overrides.py +++ b/juju/client/overrides.py @@ -8,13 +8,29 @@ __all__ = [ 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')