[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#10754: define-minor-mode and doc of derived mode
From: |
John Shahid |
Subject: |
bug#10754: define-minor-mode and doc of derived mode |
Date: |
Wed, 20 Jun 2018 19:33:24 +0000 |
User-agent: |
mu4e 1.1.0; emacs 27.0.50 |
Stefan Monnier <monnier@IRO.UMontreal.CA> writes:
>>> I think we can avoid it by looking for the presence of ARG in
>>> the docstring
>> I think this can work, but it doesn't feel very elegant or obvious from
>> the pov of the caller of `define-minor-mode'. What's wrong with adding
>> an extra keyword arg ?
>
> I think in the long term (asymptotically), the arg is unneeded.
> But if we add the arg, the long term will be that *all* calls will use
> the arg, so we'll never be able to get rid of it.
I'm worried about minor modes that don't even mention the argument. Not
sure if that should be a concern since they should be documenting the
ARG in the first place. I can provide examples, but the Emacs codebase
has a few of those.
>
> I'd be OK with an arg of the form :dont-add-arg-paragraph (for those
> hypothetical cases where the paragraph is undesirable) but not
> :add-arg-paragraph.
Sounds good. I will make this change and reply with a patch.
>
>>> (or by simply always adding it, and then going through
>>> the various minor modes and remove the corresponding text from their
>>> docstrings).
>> I think this change needs to be backward compatible. There could be
>> other callers that aren't packaged with Emacs.
>
> Having the same text twice in the output of `C-h f` is fairly harmless
> in my opinion. We've had similar situations where `C-h v` automatically
> adds text like "this is only for interactive use" even tho the docstring
> may already say it.
>
>
> Stefan
- 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/07
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/08
- bug#10754: define-minor-mode and doc of derived mode, Eli Zaretskii, 2018/06/16
- bug#10754: define-minor-mode and doc of derived mode, Stefan Monnier, 2018/06/16
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/17
- bug#10754: define-minor-mode and doc of derived mode, Stefan Monnier, 2018/06/17
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/17
- bug#10754: define-minor-mode and doc of derived mode, Stefan Monnier, 2018/06/17
- bug#10754: define-minor-mode and doc of derived mode, John Shahid, 2018/06/17
- bug#10754: define-minor-mode and doc of derived mode, Stefan Monnier, 2018/06/18
- bug#10754: define-minor-mode and doc of derived mode,
John Shahid <=
- 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, 2018/06/30