From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Roelli, Charles A" Newsgroups: gmane.emacs.help Subject: Re: documentation for align-regexp and co. Date: Thu, 21 Jul 2016 11:04:56 +0000 Message-ID: <1757D49E-BEFF-458C-99AD-AF501ED47662@imperial.ac.uk> References: , NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1469099164 6709 80.91.229.3 (21 Jul 2016 11:06:04 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 21 Jul 2016 11:06:04 +0000 (UTC) Cc: "help-gnu-emacs@gnu.org" To: Kaushal Modi Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Thu Jul 21 13:05:55 2016 Return-path: Envelope-to: geh-help-gnu-emacs@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 1bQBnf-0005zA-5j for geh-help-gnu-emacs@m.gmane.org; Thu, 21 Jul 2016 13:05:55 +0200 Original-Received: from localhost ([::1]:39816 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bQBne-00058K-Cy for geh-help-gnu-emacs@m.gmane.org; Thu, 21 Jul 2016 07:05:54 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:44871) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bQBmx-00055Q-Cq for help-gnu-emacs@gnu.org; Thu, 21 Jul 2016 07:05:13 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bQBmp-0001Rx-M6 for help-gnu-emacs@gnu.org; Thu, 21 Jul 2016 07:05:11 -0400 Original-Received: from smtp1.cc.ic.ac.uk ([155.198.5.155]:48749) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bQBmp-0001Qq-2v for help-gnu-emacs@gnu.org; Thu, 21 Jul 2016 07:05:03 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=imperial.ac.uk; s=main01; h=MIME-Version:Content-Type:In-Reply-To: References:Message-ID:Date:Subject:CC:To:From; bh=+0fMaqxTu4DCtaBwv28b0oylO5E43fThdSl+k5kVomQ=; b=Ood/ux1V/vAlNE3keNGdsmaubh tzJmjF5UZjHuMn+uixIUwLH+BgbgwoqrKScExXAJo4jei52sKASe+af3vpRJIFCVJj3WbMEjBXQnV D3yOFNDfOUjqKHQnexaVjFL0/KJ9ebU/khoJbULkvTgw9+r5TzDX3YP2/dXJcwwSwBHY=; Original-Received: from icexch-h1.ic.ac.uk ([2001:630:12:610::111]) by smtp1.cc.ic.ac.uk with esmtp (Exim 4.86) (envelope-from ) id 1bQBml-00029b-8U; Thu, 21 Jul 2016 12:05:00 +0100 Original-Received: from EUR01-DB5-obe.outbound.protection.outlook.com (2a01:111:f400:7e02::204) by exchange.imperial.ac.uk (2001:630:12:610::111) with Microsoft SMTP Server (TLS) id 14.3.279.2; Thu, 21 Jul 2016 12:04:58 +0100 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ImperialLondon.onmicrosoft.com; s=selector1-imperial-ac-uk; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=+0fMaqxTu4DCtaBwv28b0oylO5E43fThdSl+k5kVomQ=; b=OlBBI0jBskTBbMgZDS6oxMFQ7j1y61fICLIPvfj+8tma+OKKuMRaYONjpXIO2ui54jhVN20piP6u3SwBmFbZm8cI3YVsRfvni7OgsxhnmKaXn7obsz9DO3uarfFYdMwHrDDKlIRJP6PZ6QItxDRNZUeW+6GDWVZyOHKsQ1Zo8OQ= Original-Received: from AM3PR06MB291.eurprd06.prod.outlook.com (10.242.108.23) by AM3PR06MB292.eurprd06.prod.outlook.com (10.242.108.25) with Microsoft SMTP Server (TLS) id 15.1.534.14; Thu, 21 Jul 2016 11:04:56 +0000 Original-Received: from AM3PR06MB291.eurprd06.prod.outlook.com ([fe80::c8fe:5a17:f02e:e6c8]) by AM3PR06MB291.eurprd06.prod.outlook.com ([fe80::c8fe:5a17:f02e:e6c8%17]) with mapi id 15.01.0544.014; Thu, 21 Jul 2016 11:04:57 +0000 Thread-Topic: documentation for align-regexp and co. Thread-Index: AQHR4sEKjlqCfhT940mZKEyiQe2Tz6Ah2TgAgADgtPY= In-Reply-To: Accept-Language: en-US Content-Language: en-GB X-MS-Has-Attach: X-MS-TNEF-Correlator: authentication-results: spf=none (sender IP is ) smtp.mailfrom=charles.roelli13@imperial.ac.uk; x-originating-ip: [109.152.227.245] x-ms-office365-filtering-correlation-id: 60ea7a09-f0a0-40c5-7c52-08d3b156da01 x-microsoft-exchange-diagnostics: 1; AM3PR06MB292; 6:djTwUoN7VphuPpQTpzKMoMButP8Rqt9LsWiN5p7QVHZ+p+itjcWqYRBt8UYbBJ7l+lGo9TunyXXkUUJWO71ens2Lws2GuSxSqQ6+gzs18djcDCsVqxaFXUdZTW6e8CaD5aFvF6XPu2anNI4oK+vtIX2LawMhdkUffIHXXvlPTo7S9/PCBDpKIvNUD9aEJTCHNXGELpJivpLTAW+QUP83PuMWC6rXkXqhcbYuDjoSMe6San0ypT7i+qgtGtZEOda2r+Uz0R7xt7Wi6nAfixlJTfzo2uz/sqVjbHPqhgNGR18=; 5:/YF18WPCSGIY7PltdtqOCrNU1m9o+wLFgPbpukPvvUnNkhp8N7CUkdlmfspkRJpQBCTKMhxbTAnebe237sCIJY64X/ePcKi5DaRTF0MAbRtD658idBDO5bTJkULUN09G4FL87QtopZkXi2QKuX+hHQ==; 24:jI38ZXfbVGvdccbZIHlh1s0ImCW61xapjo9dGFk0i0aZedsooRprCgxSfFRwiNZLZ+9Yzx9pfpjtVVs4O74caSImSAOEWRHwPOlWqibc+bE=; 7:n5yHQMueuaQBzOuOs0SdCLpVQ6ji2lBonZKNd0XI2wqZYaICk3aqGiegNtu8XHgXX7SZorHOUO5ez7q2m1UjnPxzIMkSoJI8wHIVI3UlU7RUvlmwtOUyLPSvxxksQz5nu5iMkQW43mc74fqTMvKdr4GokLHk4RBvo0+xZG+x3feYxIEnZWrBvuF0Pahss9KfOHTc4TGvE6zLj3SXBKll8oiMVz4cPw3vsWraRpO1kQxgl9iZSoc1Xs7LTkDmF0Iz x-microsoft-antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:AM3PR06MB292; x-microsoft-antispam-prvs: x-exchange-antispam-report-test: UriScan:; x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(601004)(2401047)(5005006)(8121501046)(10201501046)(3002001); SRVR:AM3PR06MB292; BCL:0; PCL:0; RULEID:; SRVR:AM3PR06MB292; x-forefront-prvs: 0010D93EFE x-forefront-antispam-report: SFV:NSPM; SFS:(10019020)(7916002)(377454003)(24454002)(199003)(189002)(82746002)(6116002)(3846002)(102836003)(15975445007)(106356001)(105586002)(106116001)(5002640100001)(586003)(83716003)(86362001)(2906002)(33656002)(19580395003)(19580405001)(5250100002)(81156014)(8676002)(68736007)(16236675004)(4326007)(101416001)(7846002)(81166006)(66066001)(74482002)(3280700002)(2950100001)(76176999)(50986999)(2900100001)(19300405004)(54356999)(3660700001)(110136002)(97736004)(87936001)(7736002)(7906003)(19617315012)(8936002)(92566002)(189998001)(36756003)(562404015)(104396002); DIR:OUT; SFP:1102; SCL:1; SRVR:AM3PR06MB292; H:AM3PR06MB291.eurprd06.prod.outlook.com; FPR:; SPF:None; PTR:InfoNoRecords; A:1; MX:1; LANG:en; received-spf: None (protection.outlook.com: imperial.ac.uk does not designate permitted sender hosts) spamdiagnosticoutput: 1:99 spamdiagnosticmetadata: NSPM X-MS-Exchange-CrossTenant-originalarrivaltime: 21 Jul 2016 11:04:56.9694 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 2b897507-ee8c-4575-830b-4f8267c3d307 X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM3PR06MB292 X-OriginatorOrg: imperial.ac.uk X-IC-MsgID: 1bQBml-00029b-8U X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 155.198.5.155 X-Content-Filtered-By: Mailman/MimeDel 2.1.21 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.org gmane.emacs.help:110900 Archived-At: Thanks Kaushal. The docstrings and the link you gave are more than enough t= o learn about the command; what I'm more worried about is having useful fun= ctions like these go forgotten if they're not written up in the manual. Do = you think it would be worth filing a bug report to have it included? It see= ms like most of the documentation is already ready to go in from the file's= source, and it would just have to be copied into the Texinfo docs. Cheers, Charles On 20 Jul 2016, at 22:41, Kaushal Modi > wrote: You are right, the emacs or elisp manual do not talk about this function. A= ll the functions in the emacs source are not documented in the manuals. But= most of them are at least documented in the function doc-strings. Please open a bug report requesting the info you find missing regarding thi= s function. What part is unclear in the docstring? etc.. For now, you might find this useful to learn more about align-regexp: http:= //emacs.stackexchange.com/q/2644/115 On Wed, Jul 20, 2016 at 5:25 PM Roelli, Charles A > wrote: I came across the function `align-regexp' which is defined in align.el. The= documentation for the function (docstrings etc.) is visible from Emacs via= the usual methods, and I can see in the code of align.el that the function= s in the file have been around since Emacs 21.1. However I couldn't find an= y documentation for any of these functions in either the Emacs or the Elisp= manual, which is surprising. Is this a mistake, or are some files/function= s purposefully left out of the official manuals? -- Kaushal Modi