bug#50903: closed (Checkdoc recommendation for docstring subsitutions is inconsistent with other documentation)

[GNU bug Tracking System]

Your message dated Thu, 30 Sep 2021 19:26:18 +0300
with message-id <83tui2f2s5.fsf@gnu.org>
and subject line Re: bug#50903: Checkdoc recommendation for docstring 
subsitutions is inconsistent with other documentation
has caused the debbugs.gnu.org bug report #50903,
regarding Checkdoc recommendation for docstring subsitutions is inconsistent 
with other documentation
to be marked as done.

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


-- 
50903: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=50903
GNU Bug Tracking System
Contact help-debbugs@gnu.org with problems

--- Begin Message --- Subject: 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.

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

--- End Message ---

> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#50903: Checkdoc recommendation for docstring subsitutions is inconsistent with other documentation
>
>
>
>
> Date: 
>
> Thu, 30 Sep 2021 19:26:18 +0300
>
>
>
>
> > From: Nikolay Kudryavtsev <nikolay.kudryavtsev@gmail.com>
> > Cc: 50903@debbugs.gnu.org
> > Date: Thu, 30 Sep 2021 16:35:59 +0300
> > 
> > Roger. s/r-d the patch.
>
> Thanks, installed.
>
>
> --- End Message ---