GNU bug report logs - #77650
30.1; strange docstring for dired-do-touch

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 77650 in the body.
You can then email your comments to 77650 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: Francesco Potortì <pot <at> potorti.it>
To: bug-gnu-emacs <at> gnu.org
Subject: 30.1; strange docstring for dired-do-touch
Date: Tue, 08 Apr 2025 19:28:18 +0200

This is the start of defun of dired-do-touch in dired-aux.el

(defun dired-do-touch (&optional arg)
  "Change the timestamp of the marked (or next ARG) files.
This calls touch.
Type Type \\<minibuffer-local-completion-map>\\[next-history-element] \
to pull the file attributes of the file at point
into the minibuffer."

The last three lines of the docstring make no sense to me because:

1. "Type" is repeated twice
2. when I call for description of "T" in a dired buffer, those lines show as:

Type Type M-n to pull the file attributes of the file at point
into the minibuffer.

But M-n calls clone-buffer

Message #10 received at 77650-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Francesco Potortì <pot <at> potorti.it>
Cc: 77650-done <at> debbugs.gnu.org
Subject: Re: bug#77650: 30.1; strange docstring for dired-do-touch
Date: Wed, 09 Apr 2025 14:27:58 +0300

> From: Francesco Potortì <pot <at> potorti.it>
> Date: Tue, 08 Apr 2025 19:28:18 +0200
> 
> This is the start of defun of dired-do-touch in dired-aux.el
> 
> (defun dired-do-touch (&optional arg)
>   "Change the timestamp of the marked (or next ARG) files.
> This calls touch.
> Type Type \\<minibuffer-local-completion-map>\\[next-history-element] \
> to pull the file attributes of the file at point
> into the minibuffer."
> 
> The last three lines of the docstring make no sense to me because:
> 
> 1. "Type" is repeated twice

That's a typo.

> 2. when I call for description of "T" in a dired buffer, those lines show as:
> 
> Type Type M-n to pull the file attributes of the file at point
> into the minibuffer.
> 
> But M-n calls clone-buffer

The intent was to tell that you can type M-n after invoking the
command.  IOW, type "T M-n".

I've now fixed this (and several similar issues in a few other doc
strings) on the emacs-30 branch, and I'm therefore closing this bug.

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

From: Francesco Potortì <pot <at> potorti.it>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 77650 <at> debbugs.gnu.org, eliz <at> gnu.org
Subject: Re: bug#77650: 30.1; strange docstring for dired-do-touch
Date: Wed, 09 Apr 2025 16:20:41 +0200

>> From: Francesco Potortì <pot <at> potorti.it>
>> Date: Tue, 08 Apr 2025 19:28:18 +0200
>> 
>> This is the start of defun of dired-do-touch in dired-aux.el
>> 
>> (defun dired-do-touch (&optional arg)
>>   "Change the timestamp of the marked (or next ARG) files.
>> This calls touch.
>> Type Type \\<minibuffer-local-completion-map>\\[next-history-element] \
>> to pull the file attributes of the file at point
>> into the minibuffer."
>> 
>> The last three lines of the docstring make no sense to me because:
>> 
>> 1. "Type" is repeated twice
>
>That's a typo.
>
>> 2. when I call for description of "T" in a dired buffer, those lines show as:
>> 
>> Type Type M-n to pull the file attributes of the file at point
>> into the minibuffer.
>> 
>> But M-n calls clone-buffer
>
>The intent was to tell that you can type M-n after invoking the
>command.  IOW, type "T M-n".
>
>I've now fixed this (and several similar issues in a few other doc
>strings) on the emacs-30 branch, and I'm therefore closing this bug.

Thanks

Previous Next

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