summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2021-02-23 23:35:25 -0500
committerKyle Meyer <kyle@kyleam.com>2021-02-23 23:35:57 -0500
commit9e98e9a731daf7bc11985edae29d01203027dcd0 (patch)
tree0ab2950e55260ac66f75609d51df8738c2b363dc
parentd21d200bc0611615624a5624c2e19285545d8e48 (diff)
downloadorg-mode-9e98e9a731daf7bc11985edae29d01203027dcd0.tar.gz
Shorten remaining over-wide docstrings
* lisp/ob-latex.el (org-babel-latex-begin-env): (org-babel-latex-pdf-svg-process): Shorten docstring to under 80 characters. * lisp/org-plot.el (org-plot/preset-plot-types): Fill long lines and add two spaces after periods. With Emacs 28.0.50 the byte-compiler now warns about docstrings that are too wide. The recent ports from the Emacs repo covered all of the cases that have already made their way to the Emacs tree.
-rw-r--r--lisp/ob-latex.el4
-rw-r--r--lisp/org-plot.el32
2 files changed, 22 insertions, 14 deletions
diff --git a/lisp/ob-latex.el b/lisp/ob-latex.el
index 2bd7ec5..748d15e 100644
--- a/lisp/ob-latex.el
+++ b/lisp/ob-latex.el
@@ -84,7 +84,7 @@ It takes 1 argument which is the parameters of the source block."
(defcustom org-babel-latex-begin-env
(lambda (_)
"\\begin{document}")
- "Closure which evaluates at runtime to the begin part of the document environment.
+ "Function that evaluates to the begin part of the document environment.
It takes 1 argument which is the parameters of the source block.
This allows adding additional code that will be ignored when
@@ -105,7 +105,7 @@ exporting the literal LaTeX source."
(defcustom org-babel-latex-pdf-svg-process
"inkscape --pdf-poppler %f -T -l -o %O"
- "Command used to convert a PDF file to an SVG file when executing a latex source block."
+ "Command to convert a PDF file to an SVG file."
:group 'org-babel
:type 'string)
diff --git a/lisp/org-plot.el b/lisp/org-plot.el
index f23035e..28cff94 100644
--- a/lisp/org-plot.el
+++ b/lisp/org-plot.el
@@ -349,34 +349,42 @@ If a function, it is called with the plot type as the argument."
(lambda (table _data-file _num-cols params plot-str)
(list (org--plot/radar table params)))))
"List of plists describing the avalible plot types.
-The car is the type name, and the property :plot-func must be set.
-The value of :plot-func is a lambda which yields plot-lines
+The car is the type name, and the property :plot-func must be
+set. The value of :plot-func is a lambda which yields plot-lines
(a list of strings) as the cdr.
-All lambda functions have the parameters of `org-plot/gnuplot-script' and PLOT-STR passed to them.
-i.e. they are called with the following signature: (TABLE DATA-FILE NUM-COLS PARAMS PLOT-STR)
+All lambda functions have the parameters of
+`org-plot/gnuplot-script' and PLOT-STR passed to them. i.e. they
+are called with the following signature: (TABLE DATA-FILE
+NUM-COLS PARAMS PLOT-STR)
Potentially useful parameters in PARAMS include:
:set :line :map :title :file :ind :timeind :timefmt :textind
:deps :labels :xlabels :ylabels :xmin :xmax :ymin :ymax :ticks
-In addition to :plot-func, the following optional properties may be set.
+In addition to :plot-func, the following optional properties may
+be set.
- :plot-cmd - A gnuplot command appended to each plot-line.
- Accepts string or nil. Default value: nil.
+ Accepts string or nil. Default value: nil.
- :check-ind-type - Whether the types of ind values should be checked.
Accepts boolean.
- :plot-str - the formula string passed to :plot-func as PLOT-STR
- Accepts string. Default value: \"'%s' using %s%d%s with %s title '%s'\"
+ Accepts string. Default value: \"'%s' using %s%d%s with %s title '%s'\"
-- :data-dump - Function to dump the table to a datafile for ease of use.
- Accepts lambda function. Default lambda body: (org-plot/gnuplot-to-data table data-file params)
+- :data-dump - Function to dump the table to a datafile for ease of
+ use.
-- :plot-pre - Gnuplot code to be inserted early into the script, just after term and output have been set.
- Accepts string, nil, or lambda function which returns string or nil. Defaults to nil.
-"
+ Accepts lambda function. Default lambda body:
+ (org-plot/gnuplot-to-data table data-file params)
+
+- :plot-pre - Gnuplot code to be inserted early into the script, just
+ after term and output have been set.
+
+ Accepts string, nil, or lambda function which returns string
+ or nil. Defaults to nil."
:group 'org-plot
:type '(alist :value-type (symbol group)))