summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2024-10-12 08:44:28 +0300
committerEli Zaretskii <eliz@gnu.org>2024-10-12 08:44:28 +0300
commitfb155bcfb6f7dfdec3aaf9f535428d46419a6b4e (patch)
tree6148d40013d7714aa0ee291e96135ce932e194e7 /lisp/emacs-lisp
parent6dbe4e99ac41bc1f5bcbdbda3c215941170bc9c5 (diff)
downloademacs-fb155bcfb6f7dfdec3aaf9f535428d46419a6b4e.tar.gz
emacs-fb155bcfb6f7dfdec3aaf9f535428d46419a6b4e.tar.bz2
emacs-fb155bcfb6f7dfdec3aaf9f535428d46419a6b4e.zip
; * lisp/emacs-lisp/chart.el (chart-bar-quickie): Doc fix.
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r--lisp/emacs-lisp/chart.el15
1 files changed, 10 insertions, 5 deletions
diff --git a/lisp/emacs-lisp/chart.el b/lisp/emacs-lisp/chart.el
index b9646e93253..c472d421eb0 100644
--- a/lisp/emacs-lisp/chart.el
+++ b/lisp/emacs-lisp/chart.el
@@ -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