From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 6 Mar 2020 08:14:42 +0000 (+0200)
Subject: Improve documentation of 'table-generate-source'
X-Git-Tag: emacs-27.0.91~124
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=3f9c340de0;p=emacs.git

Improve documentation of 'table-generate-source'

* lisp/textmodes/table.el (table-generate-source): Doc fix.
(Bug#39935)

* etc/NEWS: Fix wording of the 'table-generate-source' entry and
mark it as documented.
---

diff --git a/etc/NEWS b/etc/NEWS
index 8d0e0b67591..3332143dc23 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -768,8 +768,9 @@ an offset to absolute line numbers.
 
 ** table
 
-*** 'table-generate-source' and friends now support outputting wiki and
-mediawiki format tables.
++++
+*** 'table-generate-source' now supports wiki and mediawiki
+This command can now output wiki and mediawiki format tables.
 
 ---
 ** telnet-mode
diff --git a/lisp/textmodes/table.el b/lisp/textmodes/table.el
index 4482e7d4d23..bd2cac7aebb 100644
--- a/lisp/textmodes/table.el
+++ b/lisp/textmodes/table.el
@@ -2912,16 +2912,17 @@ WHERE is provided the cell and table at that location is reported."
 (defun table-generate-source (language &optional dest-buffer caption)
   "Generate source of the current table in the specified language.
 LANGUAGE is a symbol that specifies the language to describe the
-structure of the table.  It must be either `html', `latex' or `cals'.
-The resulted source text is inserted into DEST-BUFFER and the buffer
-object is returned.  When DEST-BUFFER is omitted or nil the default
-buffer specified in `table-dest-buffer-name' is used.  In this case
-the content of the default buffer is erased prior to the generation.
-When DEST-BUFFER is non-nil it is expected to be either a destination
-buffer or a name of the destination buffer.  In this case the
-generated result is inserted at the current point in the destination
-buffer and the previously existing contents in the buffer are
-untouched.
+structure of the table.  It must be either `html', `latex', `cals',
+`wiki', or `mediawiki'.
+The function inserts the resulting source text into DEST-BUFFER, and
+returns the buffer object.  When DEST-BUFFER is omitted or nil, the
+function uses the default buffer specified in `table-dest-buffer-name'.
+In this case, the function erases the default buffer prior to the
+source generation.
+When DEST-BUFFER is non-nil, it should be either a destination
+buffer or a name of the destination buffer.  In that case, the
+function inserts the generated result at point in the destination
+buffer, and leaves the previous contents of the buffer untouched.
 
 References used for this implementation: