Browse Source

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.
Nicolas Goaziou 9 years ago
parent
commit
28a8d2e24e
1 changed files with 17 additions and 15 deletions
  1. 17 15
      lisp/org-table.el

+ 17 - 15
lisp/org-table.el

@@ -2641,20 +2641,18 @@ This function assumes the table is already analyzed (i.e., using
 					 suppress-store suppress-analysis)
 					 suppress-store suppress-analysis)
   "Replace the table field value at the cursor by the result of a calculation.
   "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
 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
 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
 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
 When called, the command first prompts for a formula, which is read in
 the minibuffer.  Previously entered formulas are available through the
 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.
 deleting columns with the corresponding commands.
 
 
 The formula can be any algebraic expression understood by the Calc package.
 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
 This function can also be called from Lisp programs and offers
 additional arguments: EQUATION can be the formula to apply.  If this
 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.
 formula, assuming that this has been done already outside the function.
 SUPPRESS-STORE means the formula should not be stored, either because
 SUPPRESS-STORE means the formula should not be stored, either because
 it is already stored, or because it is a modified equation that should
 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")
   (interactive "P")
   (org-table-check-inside-data-field)
   (org-table-check-inside-data-field)
   (or suppress-analysis (org-table-analyze))
   (or suppress-analysis (org-table-analyze))
@@ -3128,10 +3127,13 @@ T1 is nil, always messages."
 ;;;###autoload
 ;;;###autoload
 (defun org-table-recalculate (&optional all noalign)
 (defun org-table-recalculate (&optional all noalign)
   "Recalculate the current table line by applying all stored formulas.
   "Recalculate the current table line by applying all stored formulas.
+
 With prefix arg ALL, do this for all lines in the table.
 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
 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
 are done.  This is typically used internally to save time, if it is
 known that the table will be realigned a little later anyway."
 known that the table will be realigned a little later anyway."