branch: master commit 66f4359b8812a2104549abd2b34a9a0f075261e6 Author: Alexey Veretennikov <alexey.veretenni...@gmail.com> Commit: Alexey Veretennikov <alexey.veretenni...@gmail.com>
Updated to reflect GNU ELPA 1) Merged commit f10533854f4c7bb54247a11981191bf37b70cb36 by Paul Eggert <egg...@cs.ucla.edu> Date: Mon Jul 11 20:10:02 2016 +0200 Fix some quoting problems in doc strings Most of these are minor issues involving, e.g., quoting `like this' instead of 'like this'. A few involve escaping ` and ' with a preceding \= when the characters should not be turned into curved single quotes. 2) Bumped version --- ztree-diff-model.el | 14 +++++++------- ztree-diff.el | 10 +++++----- ztree-dir.el | 14 +++++++------- ztree-util.el | 4 ++-- ztree-view.el | 16 ++++++++-------- ztree.el | 2 +- 6 files changed, 30 insertions(+), 30 deletions(-) diff --git a/ztree-diff-model.el b/ztree-diff-model.el index 2e06b80..20df0c0 100644 --- a/ztree-diff-model.el +++ b/ztree-diff-model.el @@ -3,7 +3,7 @@ ;; Copyright (C) 2013-2016 Free Software Foundation, Inc. ;; ;; Author: Alexey Veretennikov <alexey.veretenni...@gmail.com> -;; +;; ;; Created: 2013-11-11 ;; ;; Keywords: files tools @@ -179,7 +179,7 @@ left and right parts existing." (defun ztree-diff-model-subtree (parent path side diff) "Create a subtree with given PARENT for the given PATH. -Argument SIDE either 'left or 'right side. +Argument SIDE either `left' or `right' side. Argument DIFF different status to be assigned to all created nodes." (let ((files (ztree-directory-files path)) (result nil)) @@ -219,7 +219,7 @@ Argument DIFF different status to be assigned to all created nodes." (defun ztree-diff-model-update-diff (old new) "Get the diff status depending if OLD or NEW is not nil. -If the OLD is 'ignore, do not change anything" +If the OLD is `ignore', do not change anything" ;; if the old whole directory is ignored, ignore children's status (cond ((eql old 'ignore) 'ignore) ;; if the new status is ignored, use old @@ -242,14 +242,14 @@ setting status from the NODE, unless they have an ignore status" ;; otherwise only update status when the child status is not ignore (mapc (lambda (child) (when (or (eql status 'ignore) - (not + (not (or (eql status 'ignore) (eql (ztree-diff-node-different child) 'ignore)))) (setf (ztree-diff-node-different child) status) (ztree-diff-node-update-diff-from-parent child))) children))) - - + + (defun ztree-diff-model-find-in-files (list shortname is-dir) "Find in LIST of files the file with name SHORTNAME. @@ -370,7 +370,7 @@ 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)) + (setf ztree-diff-model-progress-fun progess-fun)) (provide 'ztree-diff-model) diff --git a/ztree-diff.el b/ztree-diff.el index 5ff3247..c454709 100644 --- a/ztree-diff.el +++ b/ztree-diff.el @@ -3,7 +3,7 @@ ;; Copyright (C) 2013-2016 Free Software Foundation, Inc. ;; ;; Author: Alexey Veretennikov <alexey.veretenni...@gmail.com> -;; +;; ;; Created: 2013-11-11 ;; ;; Keywords: files tools @@ -33,7 +33,7 @@ (defconst ztree-diff-hidden-files-regexp "^\\." "Hidden files regexp. -By default all filest starting with dot '.', including . and ..") +By default all filest starting with dot `.', including . and ..") (defface ztreep-diff-header-face '((((type tty pc) (class color)) :foreground "lightblue" :weight bold) @@ -478,7 +478,7 @@ unless it is a parent node." (eql diff 'diff)) ;; or it is ignored but we show ignored for now (and (eql diff 'ignore) - ztree-diff-show-filtered-files) + ztree-diff-show-filtered-files) ;; or they are same but we show same for now (and (eql diff 'same) ztree-diff-show-equal-files)))) @@ -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 mesage with one more `.' progress indication." (if msg (setq ztree-diff-wait-message msg) (when ztree-diff-wait-message @@ -549,7 +549,7 @@ Argument DIR2 right directory." (ztree-diff-update-wait-message (concat "Comparing " dir1 " and " dir2 " ...")) (ztree-diff-node-recreate model) (message "Done.") - + (ztree-refresh-buffer))) diff --git a/ztree-dir.el b/ztree-dir.el index a340c5e..7d866ff 100644 --- a/ztree-dir.el +++ b/ztree-dir.el @@ -3,7 +3,7 @@ ;; Copyright (C) 2013-2016 Free Software Foundation, Inc. ;; ;; Author: Alexey Veretennikov <alexey.veretenni...@gmail.com> -;; +;; ;; Created: 2013-11-11 ;; ;; Keywords: files tools @@ -28,7 +28,7 @@ ;;; Commentary: ;; ;; Add the following to your .emacs file: -;; +;; ;; (push (substitute-in-file-name "path-to-ztree-directory") load-path) ;; (require 'ztree-dir) ;; @@ -53,11 +53,11 @@ (defconst ztree-hidden-files-regexp "^\\." "Hidden files regexp. -By default all filest starting with dot '.', including . and ..") +By default all filest starting with dot `.', including . and ..") ;; ;; Configurable variables -;; +;; (defvar ztree-dir-move-focus nil "If set to true moves the focus to opened window when the @@ -118,8 +118,8 @@ One could add own filters in the following way: "Determines if the file with FILENAME should be visible." (let ((name (ztree-file-short-name filename))) (and (not (or (string= name ".") (string= name ".."))) - (or - ztree-dir-show-filtered-files + (or + ztree-dir-show-filtered-files (not (cl-find-if (lambda (rx) (string-match rx name)) ztree-dir-filter-list)))))) @@ -133,7 +133,7 @@ Otherwise, the ztree window is used to find the file." (find-file-other-window node)) (hard (save-selected-window (find-file-other-window node))) - (t + (t (find-file node))))) diff --git a/ztree-util.el b/ztree-util.el index c637e8f..07935b7 100644 --- a/ztree-util.el +++ b/ztree-util.el @@ -3,7 +3,7 @@ ;; Copyright (C) 2013-2016 Free Software Foundation, Inc. ;; ;; Author: Alexey Veretennikov <alexey.veretenni...@gmail.com> -;; +;; ;; Created: 2013-11-11 ;; ;; Keywords: files tools @@ -44,7 +44,7 @@ Taken from http://www.emacswiki.org/emacs/ElispCookbook#toc39" (defun ztree-printable-string (string) - "Strip newline character from file names, like 'Icon\n. + "Strip newline character from file names, like `Icon\n'. Argument STRING string to process.'." (replace-regexp-in-string "\n" "" string)) diff --git a/ztree-view.el b/ztree-view.el index 3244ccc..f1a9afd 100644 --- a/ztree-view.el +++ b/ztree-view.el @@ -3,7 +3,7 @@ ;; Copyright (C) 2013-2016 Free Software Foundation, Inc. ;; ;; Author: Alexey Veretennikov <alexey.veretenni...@gmail.com> -;; +;; ;; Created: 2013-11-11 ;; ;; Keywords: files tools @@ -73,7 +73,7 @@ If ith value is i - it is the root line") Used in order to not to use cl package and `lexical-let'") (defvar-local ztree-line-tree-properties nil - "Hash with key - line number, value - property ('left, 'right, 'both). + "Hash with key - line number, value - property (`left', `right', `both'). Used for 2-side trees, to determine if the node exists on left or right or both sides") @@ -95,8 +95,8 @@ For example if the node is a directory") "Function returning list of node contents.") (defvar-local ztree-node-side-fun nil - "Function returning position of the node: 'left, 'right or 'both. -If not defined(by default) - using single screen tree, otherwise + "Function returning position of the node: `left', `right' or `both'. +If not defined (by default) - using single screen tree, otherwise the buffer is split to 2 trees") (defvar-local ztree-node-face-fun nil @@ -321,7 +321,7 @@ Argument NODE node which contents will be returned." #'(lambda (f) (not (funcall ztree-node-is-expandable-fun f))) nodes) comp)))) - + (defun ztree-draw-char (c x y &optional face) "Draw char C at the position (1-based) (X Y). @@ -352,7 +352,7 @@ It is just vertical bar when unicode disabled" (if ztree-draw-unicode-lines #x251C ?\|)) (defun ztree-draw-vertical-line (y1 y2 x &optional face) - "Draw a vertical line of '|' characters from Y1 row to Y2 in X column. + "Draw a vertical line of `|' characters from Y1 row to Y2 in X column. Optional argument FACE face to draw line with." (let ((ver-line-char (ztree-vertical-line-char)) (count (abs (- y1 y2)))) @@ -367,7 +367,7 @@ Optional argument FACE face to draw line with." (ztree-draw-char ver-line-char x (+ y1 count) face))))) (defun ztree-draw-vertical-rounded-line (y1 y2 x &optional face) - "Draw a vertical line of '|' characters finishing with '`' character. + "Draw a vertical line of `|' characters finishing with `\\=`' character. Draws the line from Y1 row to Y2 in X column. Optional argument FACE facet to draw the line with." (let ((ver-line-char (ztree-vertical-line-char)) @@ -558,7 +558,7 @@ and [-] or [+] depending on if it is EXPANDED from the specified OFFSET. Optional argument FACE face to write text with." (let ((node-sign #'(lambda (exp) (let ((sign (concat "[" (if exp "-" "+") "]"))) - (insert (propertize sign + (insert (propertize sign 'font-lock-face ztreep-expand-sign-face))))) ;; face to use. if FACE is not null, use it, otherwise diff --git a/ztree.el b/ztree.el index 300ed85..dbe9911 100644 --- a/ztree.el +++ b/ztree.el @@ -4,7 +4,7 @@ ;; ;; Author: Alexey Veretennikov <alexey.veretenni...@gmail.com> ;; Created: 2013-11-11 -;; Version: 1.0.3 +;; Version: 1.0.4 ;; Package-Requires: ((cl-lib "0")) ;; Keywords: files tools ;; URL: https://github.com/fourier/ztree