summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <mail@nicolasgoaziou.fr>2016-03-25 23:11:34 +0100
committerNicolas Goaziou <mail@nicolasgoaziou.fr>2016-03-25 23:11:34 +0100
commit28a8d2e24e19932338ec3b445f0c1341fefd95ab (patch)
tree03b2f3c597d17125b8e27be14e969cfdba424595
parent0b077de733082fc171ee67760b0f04dd306f7a5a (diff)
downloadorg-mode-28a8d2e24e19932338ec3b445f0c1341fefd95ab.tar.gz
org-table: Fix docstrings
* lisp/org-table.el (org-table-eval-formula): Nowadays, Calc is installed with Emacs, so there is no need to specify this. Also remove hard-coded "C-u". (org-table-recalculate): Fix code typo.
-rw-r--r--lisp/org-table.el32
1 files changed, 17 insertions, 15 deletions
diff --git a/lisp/org-table.el b/lisp/org-table.el
index c6eb337..0d0e216 100644
--- a/lisp/org-table.el
+++ b/lisp/org-table.el
@@ -2641,20 +2641,18 @@ This function assumes the table is already analyzed (i.e., using
suppress-store suppress-analysis)
"Replace the table field value at the cursor by the result of a calculation.
-This function makes use of Dave Gillespie's Calc package, in my view the
-most exciting program ever written for GNU Emacs. So you need to have Calc
-installed in order to use this function.
-
In a table, this command replaces the value in the current field with the
result of a formula. It also installs the formula as the \"current\" column
formula, by storing it in a special line below the table. When called
-with a `C-u' prefix, the current field must be a named field, and the
-formula is installed as valid in only this specific field.
+with a `\\[universal-argument]' prefix the formula is installed as a \
+field formula.
-When called with two `C-u' prefixes, insert the active equation
-for the field back into the current field, so that it can be
-edited there. This is useful in order to use \\[org-table-show-reference]
-to check the referenced fields.
+When called with a `\\[universal-argument] \\[universal-argument]' prefix, \
+insert the active equation for the field
+back into the current field, so that it can be edited there. This is \
+useful
+in order to use \\<org-table-fedit-map>`\\[org-table-show-reference]' to \
+check the referenced fields.
When called, the command first prompts for a formula, which is read in
the minibuffer. Previously entered formulas are available through the
@@ -2663,7 +2661,7 @@ These stored formulas are adapted correctly when moving, inserting, or
deleting columns with the corresponding commands.
The formula can be any algebraic expression understood by the Calc package.
-For details, see the Org-mode manual.
+For details, see the Org mode manual.
This function can also be called from Lisp programs and offers
additional arguments: EQUATION can be the formula to apply. If this
@@ -2673,7 +2671,8 @@ SUPPRESS-CONST suppresses the interpretation of constants in the
formula, assuming that this has been done already outside the function.
SUPPRESS-STORE means the formula should not be stored, either because
it is already stored, or because it is a modified equation that should
-not overwrite the stored one."
+not overwrite the stored one. SUPPRESS-ANALYSIS prevents any call to
+`org-table-analyze'."
(interactive "P")
(org-table-check-inside-data-field)
(or suppress-analysis (org-table-analyze))
@@ -3128,10 +3127,13 @@ T1 is nil, always messages."
;;;###autoload
(defun org-table-recalculate (&optional all noalign)
"Recalculate the current table line by applying all stored formulas.
+
With prefix arg ALL, do this for all lines in the table.
-With the prefix argument ALL is `(16)' \
-\(a double \\[universal-prefix] \\[universal-prefix] prefix), or if
-it is the symbol `iterate', recompute the table until it no longer changes.
+
+When called with a `\\[universal-argument] \\[universal-argument]' prefix, or \
+if ALL is the symbol `iterate',
+recompute the table until it no longer changes.
+
If NOALIGN is not nil, do not re-align the table after the computations
are done. This is typically used internally to save time, if it is
known that the table will be realigned a little later anyway."