From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Kaushal Modi Newsgroups: gmane.emacs.help Subject: Re: documentation for align-regexp and co. Date: Wed, 20 Jul 2016 21:40:42 +0000 Message-ID: References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1469050898 13940 80.91.229.3 (20 Jul 2016 21:41:38 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 20 Jul 2016 21:41:38 +0000 (UTC) To: "Roelli, Charles A" , "help-gnu-emacs@gnu.org" Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Wed Jul 20 23:41:37 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 1bPzFH-0003pe-70 for geh-help-gnu-emacs@m.gmane.org; Wed, 20 Jul 2016 23:41:35 +0200 Original-Received: from localhost ([::1]:37230 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bPzFG-0000IC-Dn for geh-help-gnu-emacs@m.gmane.org; Wed, 20 Jul 2016 17:41:34 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:48218) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bPzEd-0000Fn-O7 for help-gnu-emacs@gnu.org; Wed, 20 Jul 2016 17:40:56 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bPzEb-0000oh-KH for help-gnu-emacs@gnu.org; Wed, 20 Jul 2016 17:40:54 -0400 Original-Received: from mail-oi0-x234.google.com ([2607:f8b0:4003:c06::234]:35287) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bPzEb-0000ob-F9 for help-gnu-emacs@gnu.org; Wed, 20 Jul 2016 17:40:53 -0400 Original-Received: by mail-oi0-x234.google.com with SMTP id l72so90959086oig.2 for ; Wed, 20 Jul 2016 14:40:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:references:in-reply-to:from:date:message-id:subject:to; bh=Op80JXM5gejTe2ssEnl4/H5uVfceJA/J6EGg7bEaFXg=; b=J8c9qmTbCl+Ej8//1Nh1hqLaNMAqDRSxr1H0KMO253lc9dKS0ASReARV66AyjPoiTJ 3/BsPYDg5oRocE8wdqFZaUJ1peJZ77hdcJWM0O45405M4tk7jjJycdA8M+v9FElf+Mlm azqtMY2lP5hnJHkjXiE8zb2dmVVhIav/YHdevyZGXELIwm+ZLvb1py7VFcBd0r3KT1gh rTIgP50zb9IKuOz8rTP4lRSaiNfy6X7h4TX1Z6foUQNEyvnkHcvdmf/7BCd91AnxwCBZ l5M4u9p+vY4zZ3qzY8ivw+OSLe85Enc1F9kwxsYxab5zy5F/dO8RJ5fqogkdsArOvG+l lT/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=Op80JXM5gejTe2ssEnl4/H5uVfceJA/J6EGg7bEaFXg=; b=Bki6zA4kLwRHwi0kOBaiPGSIs89VOgvTp4mt9A7rCHIur7cY00uvdoXpBTD7zX1laD Hq6tm0fXftZQDAy1oxCu94wrJJUKULVopabAa4eMY+TLFLu59nthr0K1X74lMPwyujWq jMeoJQSC5IIAjlWS5yW+DTtudhfqRV2rRlS1eXss5qewTLLY8YwoT7v6pLPJ71+5PkTI T+xjJ6BOt1PK26fj+xwPextrD1v5i39O2OkzqEqGVfKowedH24MzD0Ojk7osxBfqedfa EZscJtbvQD9gn1Wq9Lw4gb3PDW9yNStm+T4wxfQ5EVVm3CZeCbnqEERMrkZ4bnOAcXgB tSYw== X-Gm-Message-State: ALyK8tKkNVrJR4Cc7wKrSPDFiOvqmu8D9JRtQxY3rpzPH3XZg4ulVCRAd5FiYmJ5Azjag2VtfmX1ZjbJOHg7og== X-Received: by 10.202.199.149 with SMTP id x143mr24333584oif.50.1469050852915; Wed, 20 Jul 2016 14:40:52 -0700 (PDT) In-Reply-To: X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2607:f8b0:4003:c06::234 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:110899 Archived-At: You are right, the emacs or elisp manual do not talk about this function. All 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 this 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 < charles.roelli13@imperial.ac.uk> wrote: > I came across the function `align-regexp' which is defined in align.el. > The documentation for the function (docstrings etc.) is visible from Emac= s > via the usual methods, and I can see in the code of align.el that the > functions in the file have been around since Emacs 21.1. However I couldn= =E2=80=99t > find any 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/functions purposefully left out of the official manuals? > --=20 Kaushal Modi