mirrors/org-mode
0
0
Fork 1
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-07-16 23:46:28 +00:00
Code Releases Activity

Fix docstrings in org-plot.el.

Browse source
This commit is contained in:
Carsten Dominik 2008-09-18 18:26:11 +02:00
parent 07a6432d52
commit 17bdd57209
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
lisp/org-plot.el
View file

@ -47,7 +47,7 @@
"Default options to gnuplot used by `org-plot/gnuplot'") "Default options to gnuplot used by `org-plot/gnuplot'")
(defun org-plot/add-options-to-plist (p options) (defun org-plot/add-options-to-plist (p options)
"Parse an OPTONS line and set values in the property list P. "Parse an OPTIONS line and set values in the property list P.
Returns the resulting property list." Returns the resulting property list."
(let (o) (let (o)
(when options (when options
@ -92,9 +92,9 @@ Return value is the point at the beginning of the table."
(goto-char (org-table-begin))) (goto-char (org-table-begin)))
(defun org-plot/collect-options (&optional params) (defun org-plot/collect-options (&optional params)
"Collect options from an org-plot '#+Plot:' line. Accepts an "Collect options from an org-plot '#+Plot:' line.
optional property list PARAMS, to which the options will be Accepts an optional property list PARAMS, to which the options
added. Returns the resulting property list." will be added. Returns the resulting property list."
(interactive) (interactive)
(let ((line (thing-at-point 'line))) (let ((line (thing-at-point 'line)))
(if (string-match "#\\+PLOT: +\\(.*\\)$" line) (if (string-match "#\\+PLOT: +\\(.*\\)$" line)
@ -118,9 +118,10 @@ Pass PARAMS through to `orgtbl-to-generic' when exporting TABLE."
nil) nil)
(defun org-plot/gnuplot-to-grid-data (table data-file params) (defun org-plot/gnuplot-to-grid-data (table data-file params)
"Export the data in TABLE to DATA-FILE in a format appropriate "Export the data in TABLE to DATA-FILE for gnuplot.
for grid plotting by gnuplot. PARAMS specifies which columns of This means, in a format appropriate for grid plotting by gnuplot.
TABLE should be plotted as independant and dependant variables." PARAMS specifies which columns of TABLE should be plotted as independant
and dependant variables."
(interactive) (interactive)
(let* ((ind (- (plist-get params :ind) 1)) (let* ((ind (- (plist-get params :ind) 1))
(deps (if (plist-member params :deps) (deps (if (plist-member params :deps)
@ -167,9 +168,8 @@ TABLE should be plotted as independant and dependant variables."
row-vals)) row-vals))
(defun org-plot/gnuplot-script (data-file num-cols params) (defun org-plot/gnuplot-script (data-file num-cols params)
"Write a gnuplot script to DATA-FILE respecting the options set "Write a gnuplot script to DATA-FILE respecting the options set in PARAMS.
in PARAMS. NUM-COLS controls the number of columns plotted in a NUM-COLS controls the number of columns plotted in a 2-d plot."
2-d plot."
(let* ((type (plist-get params :plot-type)) (let* ((type (plist-get params :plot-type))
(with (if (equal type 'grid) (with (if (equal type 'grid)
'pm3d 'pm3d
@ -246,8 +246,8 @@ in PARAMS. NUM-COLS controls the number of columns plotted in a
;; facad functions ;; facad functions
;;;###autoload ;;;###autoload
(defun org-plot/gnuplot (&optional params) (defun org-plot/gnuplot (&optional params)
"Plot table using gnuplot. Gnuplot options can be specified "Plot table using gnuplot. Gnuplot options can be specified with PARAMS.
with PARAMS. If not given options will be taken from the +PLOT If not given options will be taken from the +PLOT
line directly before or after the table." line directly before or after the table."
(interactive) (interactive)
(require 'gnuplot) (require 'gnuplot)
@ -310,4 +310,4 @@ line directly before or after the table."
(provide 'org-plot) (provide 'org-plot)
;;; org-plot.el ends here ;;; org-plot.el ends here