aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/textmodes
diff options
context:
space:
mode:
authorEli Zaretskii2020-03-06 10:14:42 +0200
committerEli Zaretskii2020-03-06 10:14:42 +0200
commit3f9c340de04d7572b02ef1a4c3793420d29a768c (patch)
tree30ab83a6bde552f4f7be218948bf41fd114d45a1 /lisp/textmodes
parent33b31dc314cf71f3b1569f25756d69c6915168ff (diff)
downloademacs-3f9c340de04d7572b02ef1a4c3793420d29a768c.tar.gz
emacs-3f9c340de04d7572b02ef1a4c3793420d29a768c.zip
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.
Diffstat (limited to 'lisp/textmodes')
-rw-r--r--lisp/textmodes/table.el21
1 files changed, 11 insertions, 10 deletions
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."
2912(defun table-generate-source (language &optional dest-buffer caption) 2912(defun table-generate-source (language &optional dest-buffer caption)
2913 "Generate source of the current table in the specified language. 2913 "Generate source of the current table in the specified language.
2914LANGUAGE is a symbol that specifies the language to describe the 2914LANGUAGE is a symbol that specifies the language to describe the
2915structure of the table. It must be either `html', `latex' or `cals'. 2915structure of the table. It must be either `html', `latex', `cals',
2916The resulted source text is inserted into DEST-BUFFER and the buffer 2916`wiki', or `mediawiki'.
2917object is returned. When DEST-BUFFER is omitted or nil the default 2917The function inserts the resulting source text into DEST-BUFFER, and
2918buffer specified in `table-dest-buffer-name' is used. In this case 2918returns the buffer object. When DEST-BUFFER is omitted or nil, the
2919the content of the default buffer is erased prior to the generation. 2919function uses the default buffer specified in `table-dest-buffer-name'.
2920When DEST-BUFFER is non-nil it is expected to be either a destination 2920In this case, the function erases the default buffer prior to the
2921buffer or a name of the destination buffer. In this case the 2921source generation.
2922generated result is inserted at the current point in the destination 2922When DEST-BUFFER is non-nil, it should be either a destination
2923buffer and the previously existing contents in the buffer are 2923buffer or a name of the destination buffer. In that case, the
2924untouched. 2924function inserts the generated result at point in the destination
2925buffer, and leaves the previous contents of the buffer untouched.
2925 2926
2926References used for this implementation: 2927References used for this implementation:
2927 2928