From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Add hints to documentation of car and cdr for (e)lisp newcomers - take 2 Date: Thu, 15 Jul 2021 19:57:57 +0300 Message-ID: <83o8b35xbe.fsf@gnu.org> References: <8735shrl57.fsf@tullinup.koldfront.dk> <83v95c7v3v.fsf@gnu.org> <87bl74evd7.fsf@gnus.org> <87bl74ry2z.fsf@gnus.org> <831r7z7jgl.fsf@gnu.org> <83tukv60a2.fsf@gnu.org> <30917EA3-D0B2-40E0-AE09-0825ADB95591@traduction-libre.org> <871r7zilp0.fsf@gnus.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="35175"; mail-complaints-to="usenet@ciao.gmane.io" Cc: lists@traduction-libre.org, asjo@koldfront.dk, stefan@marxist.se, monnier@iro.umontreal.ca, emacs-devel@gnu.org To: Lars Ingebrigtsen Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Jul 15 18:58:48 2021 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1m44hE-0008zV-6Y for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Jul 2021 18:58:48 +0200 Original-Received: from localhost ([::1]:52144 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m44hD-0000Tz-83 for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Jul 2021 12:58:47 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:57926) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m44gi-0008Fk-9H for emacs-devel@gnu.org; Thu, 15 Jul 2021 12:58:16 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:57386) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m44gf-000681-KL; Thu, 15 Jul 2021 12:58:13 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:2398 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m44gf-0001zs-90; Thu, 15 Jul 2021 12:58:13 -0400 In-Reply-To: <871r7zilp0.fsf@gnus.org> (message from Lars Ingebrigtsen on Thu, 15 Jul 2021 18:30:35 +0200) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 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-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:271268 Archived-At: > From: Lars Ingebrigtsen > Date: Thu, 15 Jul 2021 18:30:35 +0200 > Cc: asjo@koldfront.dk, Eli Zaretskii , stefan@marxist.se, > Stefan Monnier , emacs-devel@gnu.org > > I've now tweaked how the links in *Help* work so that they take you to > the proper place in the shortdoc buffer. Thanks, but could we perhaps improve it? The display looks something like this now: split-string-shell-command is an autoloaded Lisp function in ‘shell.el’. (split-string-shell-command STRING) Other relevant functions are documented in the string group. ------ Probably introduced at or before Emacs version 28.1. ---- Split STRING (a shell command) into a list of strings. General shell syntax, like single and double quoting, as well as backslash quoting, is respected. The new sentence interrupts the continuity, and now "Probably introduced at ..." is missing the context and sounds like bad English. I think it would be better to move the reference to other functions to the end of the *Help* buffer text. After all, it's a kind-of "See also", which is normally found at the end.