emacs-devel
[Top][All Lists]
Advanced

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

Re: trunk r116610: Fix docstring typos.


From: Xue Fuqiao
Subject: Re: trunk r116610: Fix docstring typos.
Date: Sun, 02 Mar 2014 10:43:20 +0800
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux)

Juanma Barranquero <address@hidden> writes:
>> Juanma Barranquero wrote:
>>
>>>   Fix docstring typos.
>> [...]
>>> -  "Keymap used in `finder-mode'.")
>>> +  "Keymap used in Finder mode.")
>>
>> It was not a typo that I used a form that would give a hyperlink.
>> Why change it?
>
> Because of the way it is redacted, it is a reference to the *mode*,
> not the function. If you'd written "Keymaps used when running
> `finder-mode'" (or something like that) I wouldn't have changed it.
> I've done that with many docstrings where they talked about
> "something-mode" and they were refering generically to the mode, and
> not specifically the function.

Fair enough.  Maybe we should mention it in doc/lispref/tips.texi?

-- 
http://www.gnu.org/software/emacs/




reply via email to

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