diff options
| author | Eli Zaretskii | 2020-03-06 10:14:42 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2020-03-06 10:14:42 +0200 |
| commit | 3f9c340de04d7572b02ef1a4c3793420d29a768c (patch) | |
| tree | 30ab83a6bde552f4f7be218948bf41fd114d45a1 /lisp/textmodes | |
| parent | 33b31dc314cf71f3b1569f25756d69c6915168ff (diff) | |
| download | emacs-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.el | 21 |
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. |
| 2914 | LANGUAGE is a symbol that specifies the language to describe the | 2914 | LANGUAGE is a symbol that specifies the language to describe the |
| 2915 | structure of the table. It must be either `html', `latex' or `cals'. | 2915 | structure of the table. It must be either `html', `latex', `cals', |
| 2916 | The resulted source text is inserted into DEST-BUFFER and the buffer | 2916 | `wiki', or `mediawiki'. |
| 2917 | object is returned. When DEST-BUFFER is omitted or nil the default | 2917 | The function inserts the resulting source text into DEST-BUFFER, and |
| 2918 | buffer specified in `table-dest-buffer-name' is used. In this case | 2918 | returns the buffer object. When DEST-BUFFER is omitted or nil, the |
| 2919 | the content of the default buffer is erased prior to the generation. | 2919 | function uses the default buffer specified in `table-dest-buffer-name'. |
| 2920 | When DEST-BUFFER is non-nil it is expected to be either a destination | 2920 | In this case, the function erases the default buffer prior to the |
| 2921 | buffer or a name of the destination buffer. In this case the | 2921 | source generation. |
| 2922 | generated result is inserted at the current point in the destination | 2922 | When DEST-BUFFER is non-nil, it should be either a destination |
| 2923 | buffer and the previously existing contents in the buffer are | 2923 | buffer or a name of the destination buffer. In that case, the |
| 2924 | untouched. | 2924 | function inserts the generated result at point in the destination |
| 2925 | buffer, and leaves the previous contents of the buffer untouched. | ||
| 2925 | 2926 | ||
| 2926 | References used for this implementation: | 2927 | References used for this implementation: |
| 2927 | 2928 | ||