mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00
Code Issues Projects Releases Wiki Activity

Fill doc strings for ERC modules

Browse source 
* lisp/erc/erc-common.el (erc--fill-module-docstring): Add helper to
fill doc strings.
(erc--assemble-toggle, define-erc-module): Use helper to fill doc
string.
* test/lisp/erc/erc-tests.el (define-minor-mode--global,
define-minor-mode--local): Adjust expected output for generated doc
strings.  (Bug#60935.)
This commit is contained in:
F. Jason Park 2023-01-16 20:18:32 -08:00
parent 9c65ac7365
commit 39d4f32fc9
2 changed files with 33 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

28
test/lisp/erc/erc-tests.el
View file

@ -1472,7 +1472,7 @@
(ert-deftest define-erc-module--global ()
(let ((global-module '(define-erc-module mname malias
"Some docstring"
"Some docstring."
((ignore a) (ignore b))
((ignore c) (ignore d)))))
@ -1484,10 +1484,11 @@
(define-minor-mode erc-mname-mode
"Toggle ERC mname mode.
With a prefix argument ARG, enable mname if ARG is positive,
and disable it otherwise. If called from Lisp, enable the mode
if ARG is omitted or nil.
Some docstring"
With a prefix argument ARG, enable mname if ARG is positive, and
disable it otherwise. If called from Lisp, enable the mode if
ARG is omitted or nil.
Some docstring."
:global t
:group (erc--find-group 'mname 'malias)
:get #'erc--neuter-custom-variable-state
@ -1528,7 +1529,7 @@ Some docstring"
(ert-deftest define-erc-module--local ()
(let* ((global-module '(define-erc-module mname nil ; no alias
"Some docstring"
"Some docstring."
((ignore a) (ignore b))
((ignore c) (ignore d))
'local))
@ -1540,10 +1541,11 @@ Some docstring"
`(progn
(define-minor-mode erc-mname-mode
"Toggle ERC mname mode.
With a prefix argument ARG, enable mname if ARG is positive,
and disable it otherwise. If called from Lisp, enable the mode
if ARG is omitted or nil.
Some docstring"
With a prefix argument ARG, enable mname if ARG is positive, and
disable it otherwise. If called from Lisp, enable the mode if
ARG is omitted or nil.
Some docstring."
:global nil
:group (erc--find-group 'mname nil)
(if erc-mname-mode
@ -1552,7 +1554,8 @@ Some docstring"
(defun erc-mname-enable (&optional ,arg-en)
"Enable ERC mname mode.
When called interactively, do so in all buffers for the current connection."
When called interactively, do so in all buffers for the current
connection."
(interactive "p")
(when (derived-mode-p 'erc-mode)
(if ,arg-en
@ -1564,7 +1567,8 @@ When called interactively, do so in all buffers for the current connection."
(defun erc-mname-disable (&optional ,arg-dis)
"Disable ERC mname mode.
When called interactively, do so in all buffers for the current connection."
When called interactively, do so in all buffers for the current
connection."
(interactive "p")
(when (derived-mode-p 'erc-mode)
(if ,arg-dis