From: Matt <matt@excalamus.com>
To: 68088@debbugs.gnu.org
Subject: bug#68088: [PATCH] Fix incorrect docstring link in default-directory
Date: Thu, 28 Dec 2023 17:58:53 +0100 [thread overview]
Message-ID: <18cb15d56a4.11388c6eb77569.4265473526881657065@excalamus.com> (raw)
[-- 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),
next reply other threads:[~2023-12-28 16:58 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-28 16:58 Matt [this message]
2023-12-28 19:48 ` bug#68088: [PATCH] Fix incorrect docstring link in default-directory Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=18cb15d56a4.11388c6eb77569.4265473526881657065@excalamus.com \
--to=matt@excalamus.com \
--cc=68088@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.