summaryrefslogtreecommitdiff
path: root/client/src
diff options
context:
space:
mode:
authordrebs <drebs@leap.se>2017-05-04 15:59:47 +0200
committerdrebs <drebs@leap.se>2017-05-04 16:16:50 +0200
commitad065fc8c9204e6d63b7fb69b1d9cf469812237f (patch)
tree05682fee4ba560aed9f7a224a8e11a95e174deb0 /client/src
parent6008e999eea82bb4355b086453be42414a4d60c9 (diff)
[doc] add attachments documentation
Diffstat (limited to 'client/src')
-rw-r--r--client/src/leap/soledad/client/_document.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/client/src/leap/soledad/client/_document.py b/client/src/leap/soledad/client/_document.py
index 89e75fa2..38026f20 100644
--- a/client/src/leap/soledad/client/_document.py
+++ b/client/src/leap/soledad/client/_document.py
@@ -107,8 +107,9 @@ class IDocumentWithAttachment(Interface):
Return whether this document's content differs from the contents stored
in local database.
- :return: Whether this document is dirty or not.
- :rtype: bool
+ :return: A deferred which fires with True or False, depending on
+ whether this document is dirty or not.
+ :rtype: Deferred
"""
def upload_attachment(self):