extern/boxes
1
0
Fork 0
mirror of https://github.com/ascii-boxes/boxes.git synced 2025-06-24 19:51:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Boxes.el: Make the documentation for 'boxes-command-on-region' comply with 'Checkdoc'.

Browse Source
This commit is contained in:
Mike Woolley 2022-11-29 18:18:46 +00:00 committed by Thomas Jensen
parent 2051758d28
commit 6490205df9
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/boxes.el
View File

@ -46,8 +46,8 @@
;; :ensure t ;; :ensure t
;; :ensure-system-package boxes ;; :ensure-system-package boxes
;; :bind (("C-c b" . boxes-command-on-region) ;; :bind (("C-c b" . boxes-command-on-region)
;; ("C-c q" . boxes-create) ;; ("C-c q" . boxes-create)
;; ("C-c r" . boxes-remove))) ;; ("C-c r" . boxes-remove)))
;;; Code: ;;; Code:
@ -103,11 +103,13 @@
;;;###autoload ;;;###autoload
(defun boxes-command-on-region (start end type &optional remove) (defun boxes-command-on-region (start end type &optional remove)
"Create/Remove boxes from a region. "Create or Remove boxes from a region.
To create: select a region, M-x `boxes-command-on-region' & enter a box type. To create a box select a region, hit \\[boxes-command-on-region] & enter a box type.
Box type selection can use tab completion on the supported types. Box type selection uses tab completion on the supported types.
To remove a box simply prefix a 1 to the call, eg To remove a box simply prefix a 1 to the call, eg
M-1 M-x `boxes-command-on-region' will remove a box from a region." M-1 \\[boxes-command-on-region] will remove a box from a region.
When calling from Lisp, supply the region START & END and the box TYPE to
create a box. Specifying a non-nil value for REMOVE, removes the box."
(interactive (let ((string (interactive (let ((string
(completing-read (format "Box type (%s): " boxes-default-type) (completing-read (format "Box type (%s): " boxes-default-type)
boxes-types-list nil t nil 'boxes-history boxes-default-type))) boxes-types-list nil t nil 'boxes-history boxes-default-type)))