]> git.eshelyaron.com Git - emacs.git/commitdiff
; * lisp/emacs-lisp/chart.el (chart-bar-quickie): Doc fix.
authorEli Zaretskii <eliz@gnu.org>
Sat, 12 Oct 2024 05:44:28 +0000 (08:44 +0300)
committerEshel Yaron <me@eshelyaron.com>
Mon, 14 Oct 2024 17:38:38 +0000 (19:38 +0200)
(cherry picked from commit fb155bcfb6f7dfdec3aaf9f535428d46419a6b4e)

lisp/emacs-lisp/chart.el

index 55ee30a52aa649bd2e897585a96044054f8d0056..ac2e0645f96c924d9e6e254c930ee1cafe9354dd 100644 (file)
@@ -574,11 +574,16 @@ R1 and R2 are dotted pairs.  Colorize it with FACE."
 
 (defun chart-bar-quickie (dir title namelst nametitle numlst numtitle
                              &optional max sort-pred)
-  "Create a bar chart in direction DIR [`horizontal' `vertical'] named TITLE.
-NAMELST is the list of bar names and NAMETITLE is the name the of axis containing
-them.  NUMLST is the list of values and NUMTITLE is the name of the value
-axis.  Optional arguments: Set the chart's max element display to MAX, and sort
-lists with SORT-PRED if desired."
+  "Create a bar chart named TITLE in direction DIR [`horizontal' `vertical'].
+NAMELST is the list of bar names and NAMETITLE is the name the of axis
+containing them.
+NUMLST is the list of values and NUMTITLE is the name of the value
+axis.
+Optional argument MAX limits the chart's max element display to MAX by
+passing it as second argument to `chart-trim', otherwise the chart's
+display is unlimited.
+Optional argument SORT-PRED is a predicate function passed as second
+argument to `chart-sort' to sort the lists if desired."
   (let ((nc (make-instance 'chart-bar
                           :title title
                           :key-label "8-m"  ; This is a text key pic