GNU bug report logs - #68088
[PATCH] Fix incorrect docstring link in default-directory

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#68088: closed ([PATCH] Fix incorrect docstring link in
 default-directory)
Date: Thu, 28 Dec 2023 19:49:02 +0000

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

Your message dated Thu, 28 Dec 2023 21:48:33 +0200
with message-id <83bkaa6rce.fsf <at> gnu.org>
and subject line Re: bug#68088: [PATCH] Fix incorrect docstring link in default-directory
has caused the debbugs.gnu.org bug report #68088,
regarding [PATCH] Fix incorrect docstring link in default-directory
to be marked as done.

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


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

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

From: Matt <matt <at> excalamus.com>
To: "bug-gnu-emacs" <bug-gnu-emacs <at> gnu.org>
Subject: [PATCH] Fix incorrect docstring link in default-directory
Date: Thu, 28 Dec 2023 17:58:53 +0100

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

Hi,

Slashes in the docstring for `default-directory' incorrectly link to
`/', the divide function.

"...these names start with `/' or `~' and end with `/'."

Obviously, slashes in this context refer to the character, not the
operator.

Checking the sources, the error is still present on master.

See:
https://git.savannah.gnu.org/cgit/emacs.git/tree/src/buffer.c#n5343

The attached patch changes the leading grave on each slash and the
tilde to a single quote mark.

I was unable to test the patch directly.  However, such changes to an
Elisp defun docstring removes the links and preserves the quoting
(albeit a different kind of quote).

--
Matt Trzcinski
Emacs Org contributor (ob-shell)
Learn more about Org mode at https://orgmode.org
Support Org development at https://liberapay.com/org-mode

[0001-fix-incorrect-docstring-link.patch (application/octet-stream, attachment)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Matt <matt <at> excalamus.com>
Cc: 68088-done <at> debbugs.gnu.org
Subject: Re: bug#68088: [PATCH] Fix incorrect docstring link in
 default-directory
Date: Thu, 28 Dec 2023 21:48:33 +0200

> Date: Thu, 28 Dec 2023 17:58:53 +0100
> From: Matt <matt <at> excalamus.com>
> 
> Slashes in the docstring for `default-directory' incorrectly link to
> `/', the divide function.
> 
> "...these names start with `/' or `~' and end with `/'."
> 
> Obviously, slashes in this context refer to the character, not the
> operator.
> 
> Checking the sources, the error is still present on master.
> 
> See:
> https://git.savannah.gnu.org/cgit/emacs.git/tree/src/buffer.c#n5343
> 
> The attached patch changes the leading grave on each slash and the
> tilde to a single quote mark.

Thanks, I fixed that by using double-quotes instead of single quotes.

Closing.

Previous Next

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