From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Chad Brown Newsgroups: gmane.emacs.devel Subject: Re: docstrings and elisp reference Date: Wed, 7 Jun 2017 22:39:30 -0700 Message-ID: <0B83D1B3-19D8-4F85-BCD8-357FC6F1C9A7@gmail.com> References: <0BB64F35-233A-471F-B99F-51F96C4E6CCB@gmail.com> <8360g99n07.fsf@gnu.org> <86lgp4q2xa.fsf@stephe-leake.org> <7acc7d4f-23cc-4b6a-b062-ef92805e465b@default> <878tl3rz38.fsf@x230.lts> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\)) Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1496900393 12482 195.159.176.226 (8 Jun 2017 05:39:53 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Thu, 8 Jun 2017 05:39:53 +0000 (UTC) Cc: emacs-devel To: Jean-Christophe Helary Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Jun 08 07:39:49 2017 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dIqAd-0002yx-Se for ged-emacs-devel@m.gmane.org; Thu, 08 Jun 2017 07:39:47 +0200 Original-Received: from localhost ([::1]:47570 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dIqAj-0001QI-5a for ged-emacs-devel@m.gmane.org; Thu, 08 Jun 2017 01:39:53 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:43022) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dIqAZ-0001Op-1i for emacs-devel@gnu.org; Thu, 08 Jun 2017 01:39:44 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dIqAU-0001yS-4Z for emacs-devel@gnu.org; Thu, 08 Jun 2017 01:39:43 -0400 Original-Received: from mail-pf0-x243.google.com ([2607:f8b0:400e:c00::243]:33346) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dIqAT-0001yE-UY for emacs-devel@gnu.org; Thu, 08 Jun 2017 01:39:38 -0400 Original-Received: by mail-pf0-x243.google.com with SMTP id f27so3886414pfe.0 for ; Wed, 07 Jun 2017 22:39:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=kNEqZHp+YZ7068c63eZWG0Tbt6uRAmSk76h3VFWa/24=; b=Jn3eHMJ9/p3uklz/4C2vIKKM8WqkGNM59wA8uqEcwjLfp4VDI+v4uE6iHBb+ylIMDw PQ7G8YUgFZ+/wKxAkeWpD8WPc8k14EJOmXx7zDmQTJM9N6NOrS6io6YVN1yJquMs9HSY YCD2UxRzIxLKkHfZLTYGwCtGE8Zw5Dq0Lk5spFtkj/nxGpj1knfzeW9KobZqeJom/h/H 0XdETPs+0kQegGNpnML4W288zB26RW84Z0+4rJP7/2phvXmqwk+VKZ3XSVGt6AvRQqVr 1LjPqTau6rxeiDVWT6BHDgj573nUTe1o1UaVOkiFoQVuNf9Cn25gEZJOtpbgD0nr59yu jhNA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=kNEqZHp+YZ7068c63eZWG0Tbt6uRAmSk76h3VFWa/24=; b=eApm4gRR6lkcDywI5NalMs97V0VLzi3QPSZ9awcHPKgXxoB1UbJu6H+4pX1WbOQEKc WxPkEnUnfPjG9LqGtqosv3mRmaN/nEaUSQUUppyqePSv5c/gHhFRvADzxGALEVLx7ky6 dtPI5BW171JtL3/yKDiHxxRFV6luCC0eN/egIQbTpEpvtuM2YpNOVZPfgQ7REofhQehN OKggIP9q+wh0kTnVk69mkIHiByJ9AAckTMhGFPIsAjLuIaHetgICGX4O9Jkj6MIc/rp6 2NJ4D5osEx0zqP0yIggJTDYaAETciP0EWlfCWwE7vAVLvGe9sZSm57fWUaGANIcZekCp cYLQ== X-Gm-Message-State: AODbwcAB09qu/gELTDrZOcPxdZb+cfjW3yEVp01UnAHhYBke+ci8EeJ3 l7BXAAY//pJEaA== X-Received: by 10.98.103.12 with SMTP id b12mr28037139pfc.171.1496900375501; Wed, 07 Jun 2017 22:39:35 -0700 (PDT) Original-Received: from [192.168.1.3] (c-73-109-152-91.hsd1.wa.comcast.net. [73.109.152.91]) by smtp.gmail.com with ESMTPSA id v62sm6176089pfb.124.2017.06.07.22.39.32 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 07 Jun 2017 22:39:33 -0700 (PDT) In-Reply-To: X-Mailer: Apple Mail (2.3273) X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2607:f8b0:400e:c00::243 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 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" Xref: news.gmane.org gmane.emacs.devel:215517 Archived-At: > On 7Jun, 2017, at 20:48, Jean-Christophe Helary = wrote: >=20 > 2) my remark about javadoc was not intended to suggest a replacement = of the current documentation, but to have a document that has all the = docstring information (Emacs API) in one place. It would be an = alternative to the info system, with exactly the same contents. It would = be a great tool to find API information and also very practical to check = if the rules defined in the GNU Coding Standards are respected. Could you perhaps talk about what you see as the benefit to =E2=80=9Can = alternative to the info system, with exactly the same contents=E2=80=9D?=20= For example, I could imagine some small value to being able to see info = manuals incorporated into systems that have already included = documentation sets (like Zeal, mentioned earlier), but that also = represents a loss, since learning how to use info in particular =E2=80=94 = and learning how the =E2=80=9Cself-documenting=E2=80=9D part of emacs = works in general =E2=80=94 is a potent step in mastering emacs. Also, as = you might have noticed, emacs tends to prefer to incorporate other = systems, rather than the other way around. :-) Certainly, there=E2=80=99s a fair bit of friction and a lot of inertia = around both info and texifnfo, but it looks like you=E2=80=99re already = looking into that =E2=80=94 thanks in advance for that, by the way.=20 I hope that helps, ~Chad