[elpa] master 3a4df17 6/7: Updated docstrings and bumped version

[Alexey Veretennikov]

branch: master
commit 3a4df17edddef84160194802acc034cfa2dbd678
Author: Alexey Veretennikov <address@hidden>
Commit: Alexey Veretennikov <address@hidden>

    Updated docstrings and bumped version
---
 ztree-diff-model.el |   10 +++++++---
 ztree-diff.el       |    2 +-
 ztree-dir.el        |    5 ++---
 ztree.el            |    2 +-
 4 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/ztree-diff-model.el b/ztree-diff-model.el
index c8dbeb2..6f4c951 100644
--- a/ztree-diff-model.el
+++ b/ztree-diff-model.el
@@ -145,7 +145,7 @@ Returns t if equal."
     (error "Compared files are not on the same host"))
   (let* ((file1-untrampified (ztree-untrampify-filename file1))
          (file2-untrampified (ztree-untrampify-filename file2)))
-    (if (or 
+    (if (or
          (/= (nth 7 (file-attributes file1))
             (nth 7 (file-attributes file2)))
          (/= 0 (process-file diff-command nil nil nil "-q"
@@ -374,8 +374,12 @@ which returns t if the node should be ignored (like files 
starting
 with dot etc)."
   (setf ztree-diff-model-ignore-fun ignore-p))
 
-(defun ztree-diff-model-set-progress-fun (progess-fun)
-  (setf ztree-diff-model-progress-fun progess-fun))
+
+(defun ztree-diff-model-set-progress-fun (progress-fun)
+  "Setter for the buffer-local PROGRESS-FUN callback.
+This callback is called to indicate the ongoing activity.
+Callback is a function without arguments."
+  (setf ztree-diff-model-progress-fun progress-fun))
 
 (provide 'ztree-diff-model)
 
diff --git a/ztree-diff.el b/ztree-diff.el
index c454709..a4bd012 100644
--- a/ztree-diff.el
+++ b/ztree-diff.el
@@ -499,7 +499,7 @@ unless it is a parent node."
 
 
 (defun ztree-diff-update-wait-message (&optional msg)
-  "Update the wait mesage with one more `.' progress indication."
+  "Update the wait message MSG with one more `.' progress indication."
   (if msg
       (setq ztree-diff-wait-message msg)
     (when ztree-diff-wait-message
diff --git a/ztree-dir.el b/ztree-dir.el
index 5e7a509..dada7d0 100644
--- a/ztree-dir.el
+++ b/ztree-dir.el
@@ -60,8 +60,7 @@ By default all filest starting with dot `.', including . and 
..")
 ;;
 
 (defvar ztree-dir-move-focus nil
-  "If set to true moves the focus to opened window when the
-user press RETURN on file")
+  "Defines if move focus to opened window on hard-action command (RETURN) on a 
file.")
 
 (defvar-local ztree-dir-filter-list (list ztree-hidden-files-regexp)
   "List of regexp file names to filter out.
@@ -148,7 +147,7 @@ Otherwise, the ztree window is used to find the file."
 
 
 (defun ztree-dir-directory-files (path)
-  "Returns the list of files/directories for the given PATH"
+  "Return the list of files/directories for the given PATH."
   ;; remove . and .. from the list of files to avoid infinite
   ;; recursion
   (cl-remove-if (lambda (x) (string-match-p "/\\.\\.?$" x))
diff --git a/ztree.el b/ztree.el
index dbe9911..d615f64 100644
--- a/ztree.el
+++ b/ztree.el
@@ -4,7 +4,7 @@
 ;;
 ;; Author: Alexey Veretennikov <address@hidden>
 ;; Created: 2013-11-11
-;; Version: 1.0.4
+;; Version: 1.0.5
 ;; Package-Requires: ((cl-lib "0"))
 ;; Keywords: files tools
 ;; URL: https://github.com/fourier/ztree