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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#77650: closed (30.1; strange docstring for dired-do-touch)
Date: Wed, 09 Apr 2025 11:29:02 +0000

[Message part 1 (text/plain, inline)]

Your message dated Wed, 09 Apr 2025 14:27:58 +0300
with message-id <86tt6xshfl.fsf <at> gnu.org>
and subject line Re: bug#77650: 30.1; strange docstring for dired-do-touch
has caused the debbugs.gnu.org bug report #77650,
regarding 30.1; strange docstring for dired-do-touch
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
77650: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=77650
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

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 part 3 (message/rfc822, inline)]

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.

Previous Next

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