[nongnu] elpa/webpaste 25f0b32 033/298: More documentation for webpaste-paste-text function

[ELPA Syncer]

branch: elpa/webpaste
commit 25f0b3227a9be5ae94e11abf1e96a10b33845767
Author: Elis Axelsson <elis.axelsson@gmail.com>
Commit: Elis Axelsson <elis.axelsson@gmail.com>

    More documentation for webpaste-paste-text function
---
 webpaste.el | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/webpaste.el b/webpaste.el
index 35f602a..22cb677 100644
--- a/webpaste.el
+++ b/webpaste.el
@@ -117,9 +117,22 @@ return it to the user."
   (message (concat "Added " returned-url " to kill ring.")))
 
 
-;; Function to do pasting
+;;;###autoload
 (defun webpaste-paste-text (text)
-  "Paste TEXT to some paste service."
+  "Paste TEXT to some paste service.
+If ‘webpaste-provider-priority’ isn't populated, it will populate it with the
+default providers.
+
+Then if ‘webpaste-tested-providers’ isn't populated it will be populated by
+‘webpaste-provider-priority’.
+
+Then it extracts the first element of ‘webpaste-tested-providers’ and drops
+the first element from that list and gets the lambda for the provider and
+runs the lambda to paste TEXT to the paste service.  The paste-service in turn
+might call this function again with TEXT as param to retry if it failed.
+
+When we run out of providers to try, it will restart since
+‘webpaste-tested-providers’ will be empty and then populated again."
 
   ;; Populate webpaste-provider-priority if needed
   (if (eq webpaste-provider-priority nil)