GNU bug report logs - #35579
Add example of setting view-exit-action to a "function with one argument"

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 35579 in the body.
You can then email your comments to 35579 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
To: bug-gnu-emacs <at> gnu.org
Subject: Add example of setting view-exit-action to a "function with one
 argument"
Date: Sun, 05 May 2019 20:26:55 +0800

   view-exit-action is a variable defined in ‘view.el’.
   Its value is nil

     Automatically becomes buffer-local when set.

   Documentation:
   If non-nil, a function with one argument (a buffer) called when finished viewing.

Better add an example of how to set "a function with one argument". Thanks.

Message #8 received at 35579 <at> debbugs.gnu.org (full text, mbox):

From: Noam Postavsky <npostavs <at> gmail.com>
To: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
Cc: 35579 <at> debbugs.gnu.org
Subject: Re: bug#35579: Add example of setting view-exit-action to a "function
 with one argument"
Date: Mon, 06 May 2019 20:37:05 -0400

積丹尼 Dan Jacobson <jidanni <at> jidanni.org> writes:

>    view-exit-action is a variable defined in ‘view.el’.
>    Its value is nil
>
>      Automatically becomes buffer-local when set.
>
>    Documentation:
>    If non-nil, a function with one argument (a buffer) called when finished viewing.
>
> Better add an example of how to set "a function with one argument". Thanks.

I don't see why we should add an example of how to use setq or customize
in an otherwise unrelated docstring.  Or did you mean an example of how
to write a function with one argument?  I'd say that belongs in the
elisp manual.

Message #11 received at 35579 <at> debbugs.gnu.org (full text, mbox):

From: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 35579 <at> debbugs.gnu.org
Subject: Re: bug#35579: Add example of setting view-exit-action to a "function
 with one argument"
Date: Tue, 07 May 2019 08:49:41 +0800

I finally found an example:
(setq view-exit-action
      (lambda (buffer)
        (or (window-minibuffer-p (selected-window))
            (when (eq (window-buffer) (get-buffer "*Help*"))
              (if (one-window-p t)
                  (delete-frame)
                (delete-window))))))
So I think view-exit-action's docstring should have and example of what
they are expecting.

Message #14 received at 35579 <at> debbugs.gnu.org (full text, mbox):

From: martin rudalics <rudalics <at> gmx.at>
To: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>,
 Noam Postavsky <npostavs <at> gmail.com>
Cc: 35579 <at> debbugs.gnu.org
Subject: Re: bug#35579: Add example of setting view-exit-action to a "function
 with one argument"
Date: Tue, 7 May 2019 10:15:52 +0200

> I finally found an example:
> (setq view-exit-action
>        (lambda (buffer)
>          (or (window-minibuffer-p (selected-window))
>              (when (eq (window-buffer) (get-buffer "*Help*"))
>                (if (one-window-p t)
>                    (delete-frame)
>                  (delete-window))))))
> So I think view-exit-action's docstring should have and example of what
> they are expecting.

To me this example is confusing since the BUFFER argument is nowhere
used within the lambda.

martin

Message #17 received at 35579 <at> debbugs.gnu.org (full text, mbox):

From: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
To: martin rudalics <rudalics <at> gmx.at>
Cc: 35579 <at> debbugs.gnu.org, Noam Postavsky <npostavs <at> gmail.com>
Subject: Re: bug#35579: Add example of setting view-exit-action to a "function
 with one argument"
Date: Wed, 08 May 2019 11:51:41 +0800

>>>>> "mr" == martin rudalics <rudalics <at> gmx.at> writes:
mr> To me this example is confusing since the BUFFER argument is nowhere
mr> used within the lambda.

That's what I'm saying: without a proper example users will only dig up
wrong examples from the net/web.

Message #20 received at 35579 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 35579 <at> debbugs.gnu.org,
 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
Subject: Re: bug#35579: Add example of setting view-exit-action to a
 "function with one argument"
Date: Mon, 14 Oct 2019 22:50:46 +0200

Noam Postavsky <npostavs <at> gmail.com> writes:

> 積丹尼 Dan Jacobson <jidanni <at> jidanni.org> writes:
>
>>    view-exit-action is a variable defined in ‘view.el’.
>>    Its value is nil
>>
>>      Automatically becomes buffer-local when set.
>>
>>    Documentation:
>>    If non-nil, a function with one argument (a buffer) called when finished viewing.
>>
>> Better add an example of how to set "a function with one argument". Thanks.
>
> I don't see why we should add an example of how to use setq or customize
> in an otherwise unrelated docstring.  Or did you mean an example of how
> to write a function with one argument?  I'd say that belongs in the
> elisp manual.

I agree, so I'm closing this bug report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.