[elpa] externals/async 180742e 2/2: Update docstring

[ELPA Syncer]

branch: externals/async
commit 180742ec4a18107df65efca246e67d698ed23e79
Author: Thierry Volpiatto <thievol@posteo.net>
Commit: Thierry Volpiatto <thievol@posteo.net>

    Update docstring
---
 async.el | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/async.el b/async.el
index 03c5fbd..eb9da7b 100644
--- a/async.el
+++ b/async.el
@@ -350,6 +350,17 @@ will leave *emacs* process buffers hanging around):
        (delete-file \"a remote file on a slow link\" nil))
      \\='ignore)
 
+Special case:
+If the output of START-FUNC is a string with properties
+e.g. (buffer-string) RESULT will be transformed in a list where the
+car is the string itself (without props) and the cdr the rest of
+properties, this allows using in FINISH-FUNC the string without
+properties and then apply the properties in cdr to this string (if
+needed).
+Properties handling special objects like markers are returned as
+list to allow restoring them later.
+See <https://github.com/jwiegley/emacs-async/issues/145> for more infos.
+
 Note: Even when FINISH-FUNC is present, a future is still
 returned except that it yields no value (since the value is
 passed to FINISH-FUNC).  Call `async-get' on such a future always