[Emacs-diffs] master e2fd206: Fix avl-tree alias docstrings

[Mark Oteiza]

branch: master
commit e2fd20683ad6c771912958058985c9696a1fc063
Author: Mark Oteiza <address@hidden>
Commit: Mark Oteiza <address@hidden>

    Fix avl-tree alias docstrings
    
    * lisp/emacs-lisp/avl-tree.el (avl-tree--node-branch):
    (avl-tree-stack-p, avl-tree-create):
    (avl-tree-compare-function): Add calling convention to docstrings.
---
 lisp/emacs-lisp/avl-tree.el |   12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/lisp/emacs-lisp/avl-tree.el b/lisp/emacs-lisp/avl-tree.el
index 74d8e59..707d1cb 100644
--- a/lisp/emacs-lisp/avl-tree.el
+++ b/lisp/emacs-lisp/avl-tree.el
@@ -98,7 +98,8 @@
   ;; avl-tree-right avl-tree-data] branch) node)
   "Get value of a branch of a node.
 NODE is the node, and BRANCH is the branch.
-0 for left pointer, 1 for right pointer and 2 for the data.")
+0 for left pointer, 1 for right pointer and 2 for the data.
+\n(fn BRANCH NODE)")
 
 
 ;; The funcall/aref trick wouldn't work for the setf method, unless we
@@ -400,7 +401,8 @@ itself."
   reverse store)
 
 (defalias 'avl-tree-stack-p #'avl-tree--stack-p
-  "Return t if argument is an avl-tree-stack, nil otherwise.")
+  "Return t if OBJ is an avl-tree-stack, nil otherwise.
+\n(fn OBJ)")
 
 (defun avl-tree--stack-repopulate (stack)
   ;; Recursively push children of the node at the head of STACK onto the
@@ -419,12 +421,12 @@ itself."
 (defalias 'avl-tree-create #'avl-tree--create
   "Create an empty AVL tree.
 COMPARE-FUNCTION is a function which takes two arguments, A and B,
-and returns non-nil if A is less than B, and nil otherwise.")
+and returns non-nil if A is less than B, and nil otherwise.
+\n(fn COMPARE-FUNCTION)")
 
 (defalias 'avl-tree-compare-function #'avl-tree--cmpfun
   "Return the comparison function for the AVL tree TREE.
-
-\(fn TREE)")
+\n(fn TREE)")
 
 (defun avl-tree-empty (tree)
   "Return t if AVL tree TREE is empty, otherwise return nil."