Make delimit-columns-region say what it does

* lisp/delim-col.el (delimit-columns-region): Make the doc string
say a bit more about what it does (bug#35651).
(delimit-columns-rectangle): Refer to the first function.

diff --git a/lisp/delim-col.el b/lisp/delim-col.el
index b3a773e5b02b3ee1227355059ea27a0a6d1c191b..2f3ee3647e8fb875c9fc1c146a8674428124a6f7 100644 (file)
--- a/lisp/delim-col.el
+++ b/lisp/delim-col.el
@@ -258,7 +258,25 @@ at the left corner."
 (defun delimit-columns-region (start end)
   "Prettify all columns in a text region.
 
-START and END delimit the text region."
+START and END delimit the text region.
+
+If you have, for example, the following columns:
+
+       a       b       c       d
+       aaaa    bb      ccc     ddddd
+
+Depending on your settings (see below), you then obtain the
+following result:
+
+       [ a   , b  , c      , d     ]
+       [ aaaa, bb , ccc    , ddddd ]
+
+See the `delimit-columns-str-before',
+`delimit-columns-str-after', `delimit-columns-str-separator',
+`delimit-columns-before', `delimit-columns-after',
+`delimit-columns-separator', `delimit-columns-format' and
+`delimit-columns-extra' variables for customization of the
+look. "
   (interactive "*r")
   (if rectangle-mark-mode
       ;; Delegate to delimit-columns-rectangle when called with a
@@ -314,6 +332,8 @@ START and END delimit the text region."
 (defun delimit-columns-rectangle (start end)
   "Prettify all columns in a text rectangle.
 
+See `delimit-columns-region' for what this entails.
+
 START and END delimit the corners of the text rectangle."
   (interactive "*r")
   (let ((delimit-columns-str-before