bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#50903: Checkdoc recommendation for docstring subsitutions is inconsi


From: Nikolay Kudryavtsev
Subject: bug#50903: Checkdoc recommendation for docstring subsitutions is inconsistent with other documentation
Date: Wed, 29 Sep 2021 22:46:14 +0300
User-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.14.0

I had a docstring containing "C-c". Checkdoc gave me this suggestion:
"Keycode C-c embedded in doc string.  Use \\<keymap> & \\[function] instead"

Ok, but how? The relevant page of Elisp reference is (info "(elisp) Keys in Documentation"). But there they're called ‘\<MAPVAR>’ and ‘\[COMMAND]’. So someone searching by the checkdoc names would never find them there. The docstring for substitute-command-keys is also consistent with the Elisp reference.

A trivial patch is included, since Elisp reference names seem more reasonable.

I'm not sure whether MAPVAR and COMMAND should be capitalized in the docstring, so someone else should decide on that.

Attachment: 0001-checkdoc-Docstring-substitution-consistent-with-othe.patch
Description: Text document


reply via email to

[Prev in Thread] Current Thread [Next in Thread]