bug#68088: [PATCH] Fix incorrect docstring link in default-directory

bug#68088: [PATCH] Fix incorrect docstring link in default-directory

[Matt]

[-- Attachment #1: Type: text/plain, Size: 829 bytes --]

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

[-- Attachment #2: 0001-fix-incorrect-docstring-link.patch --]
[-- Type: application/octet-stream, Size: 618 bytes --]

diff --git a/src/buffer.c b/src/buffer.c
index ea0c23192b7..0696524a0fd 100644
--- a/src/buffer.c
+++ b/src/buffer.c
@@ -5359,7 +5359,7 @@ visual lines rather than logical lines.  See the documentation of
 		     Qstringp,
 		     doc: /* Name of default directory of current buffer.
 It should be an absolute directory name; on GNU and Unix systems,
-these names start with `/' or `~' and end with `/'.
+these names start with '/' or '~' and end with '/'.
 To interactively change the default directory, use command `cd'. */);
 
   DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),

bug#68088: [PATCH] Fix incorrect docstring link in default-directory

[Eli Zaretskii]

> Date: Thu, 28 Dec 2023 17:58:53 +0100
> From: Matt <matt@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.