procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of 'table-generate-source'

Browse 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.
This commit is contained in:
Eli Zaretskii 2020-03-06 10:14:42 +02:00
parent 33b31dc314
commit 3f9c340de0
2 changed files with 14 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

5
etc/NEWS
View file

@ -768,8 +768,9 @@ an offset to absolute line numbers.
** table ** 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 ** telnet-mode

21
lisp/textmodes/table.el
View file

@ -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) (defun table-generate-source (language &optional dest-buffer caption)
"Generate source of the current table in the specified language. "Generate source of the current table in the specified language.
LANGUAGE is a symbol that specifies the language to describe the LANGUAGE is a symbol that specifies the language to describe the
structure of the table. It must be either `html', `latex' or `cals'. structure of the table. It must be either `html', `latex', `cals',
The resulted source text is inserted into DEST-BUFFER and the buffer `wiki', or `mediawiki'.
object is returned. When DEST-BUFFER is omitted or nil the default The function inserts the resulting source text into DEST-BUFFER, and
buffer specified in `table-dest-buffer-name' is used. In this case returns the buffer object. When DEST-BUFFER is omitted or nil, the
the content of the default buffer is erased prior to the generation. function uses the default buffer specified in `table-dest-buffer-name'.
When DEST-BUFFER is non-nil it is expected to be either a destination In this case, the function erases the default buffer prior to the
buffer or a name of the destination buffer. In this case the source generation.
generated result is inserted at the current point in the destination When DEST-BUFFER is non-nil, it should be either a destination
buffer and the previously existing contents in the buffer are buffer or a name of the destination buffer. In that case, the
untouched. 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: References used for this implementation: