From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Xue Fuqiao Newsgroups: gmane.emacs.devel Subject: Re: trunk r116610: Fix docstring typos. Date: Sun, 02 Mar 2014 10:43:20 +0800 Organization: The Church of Emacs Message-ID: <87ob1p2ud3.fsf@gnu.org> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1393728226 4689 80.91.229.3 (2 Mar 2014 02:43:46 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 2 Mar 2014 02:43:46 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Mar 02 03:43:51 2014 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1WJwNb-0005vY-AA for ged-emacs-devel@m.gmane.org; Sun, 02 Mar 2014 03:43:51 +0100 Original-Received: from localhost ([::1]:34250 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WJwNa-0007Sa-NG for ged-emacs-devel@m.gmane.org; Sat, 01 Mar 2014 21:43:50 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:38972) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WJwNR-0007SL-TP for emacs-devel@gnu.org; Sat, 01 Mar 2014 21:43:48 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WJwNK-0007BJ-FQ for emacs-devel@gnu.org; Sat, 01 Mar 2014 21:43:41 -0500 Original-Received: from plane.gmane.org ([80.91.229.3]:40199) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WJwNK-0007B5-97 for emacs-devel@gnu.org; Sat, 01 Mar 2014 21:43:34 -0500 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1WJwNG-0005p4-Qp for emacs-devel@gnu.org; Sun, 02 Mar 2014 03:43:30 +0100 Original-Received: from 123.114.134.20 ([123.114.134.20]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 02 Mar 2014 03:43:30 +0100 Original-Received: from xfq by 123.114.134.20 with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 02 Mar 2014 03:43:30 +0100 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 22 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: 123.114.134.20 User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux) Cancel-Lock: sha1:yWadsgrRpIDGsAYb3MpzffMavfk= X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 80.91.229.3 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:170037 Archived-At: Juanma Barranquero 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/