[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#10754: define-minor-mode and doc of derived mode
From: |
Eli Zaretskii |
Subject: |
bug#10754: define-minor-mode and doc of derived mode |
Date: |
Sat, 30 Jun 2018 10:55:30 +0300 |
> From: John Shahid <jvshahid@gmail.com>
> Date: Fri, 29 Jun 2018 15:48:42 +0000
> Cc: Stefan Monnier <monnier@iro.umontreal.ca>, 10754@debbugs.gnu.org
I have a few minor nits:
> From: John Shahid <jvshahid@gmail.com>
> Date: Tue, 5 Jun 2018 19:56:12 -0400
> Subject: [PATCH] optionally include argument description in minor mode DOC
>
> * easy-mmode.el (define-minor-mode): Add a parapgraph to the mode's
> docstring documenting the mode ARG usage if the supplied docstring
> didn't contain the word "ARG".
Please mention the bug number in the log message.
> removed argument documetation from all minor modes.
^^^^^^^^^^^^
Typo. Also, this should be a full sentence, starting with a capital
letter.
> +(defconst easy-mmode-arg-docstring
> + "
> +
> +If called interactively, enable %s if ARG is positive, and
> +disable it otherwise. If called from Lisp, enable the mode if
> +ARG is omitted or nil, and toggle it if ARG is `toggle'. Disable
> +the mode otherwise")
I prefer this text (which also fixes a problem with only one space
between sentences):
If called interactively, enable %s if ARG is positive, and
disable it if ARG is zero or negative. If called from Lisp,
also enable the mode if ARG is omitted or nil, and toggle it
if ARG is `toggle'; disable the mode otherwise.
> -documenting what its argument does.
> +documenting what its argument does. If the word \"ARG\" does not
^
Two spaces between sentences, please.
Thanks.
- bug#10754: define-minor-mode and doc of derived mode, (continued)
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/20
- bug#10754: define-minor-mode and doc of derived mode, Stefan Monnier, 2018/06/20
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/27
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/27
- bug#10754: define-minor-mode and doc of derived mode, Stefan Monnier, 2018/06/28
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/29
- bug#10754: define-minor-mode and doc of derived mode, Stefan Monnier, 2018/06/29
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/29
- bug#10754: define-minor-mode and doc of derived mode, Noam Postavsky, 2018/06/29
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/29
- bug#10754: define-minor-mode and doc of derived mode,
Eli Zaretskii <=
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/30
- bug#10754: define-minor-mode and doc of derived mode, Eli Zaretskii, 2018/06/30