From: "Roelli, Charles A" <charles.roelli13@imperial.ac.uk>
To: Kaushal Modi <kaushal.modi@gmail.com>
Cc: "help-gnu-emacs@gnu.org" <help-gnu-emacs@gnu.org>
Subject: Re: documentation for align-regexp and co.
Date: Thu, 21 Jul 2016 11:04:56 +0000 [thread overview]
Message-ID: <1757D49E-BEFF-458C-99AD-AF501ED47662@imperial.ac.uk> (raw)
In-Reply-To: <CAFyQvY1uG13ZKmE0dp45sZRvZ_MRTzxw-+uZ2sUpLSjv54GiLA@mail.gmail.com>
Thanks Kaushal. The docstrings and the link you gave are more than enough to learn about the command; what I'm more worried about is having useful functions 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 seems 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 <kaushal.modi@gmail.com<mailto:kaushal.modi@gmail.com>> wrote:
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<mailto: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 Emacs 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't 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?
--
Kaushal Modi
next prev parent reply other threads:[~2016-07-21 11:04 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-20 19:58 documentation for align-regexp and co Roelli, Charles A
2016-07-20 21:40 ` Kaushal Modi
2016-07-21 11:04 ` Roelli, Charles A [this message]
2016-07-21 12:20 ` Kaushal Modi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1757D49E-BEFF-458C-99AD-AF501ED47662@imperial.ac.uk \
--to=charles.roelli13@imperial.ac.uk \
--cc=help-gnu-emacs@gnu.org \
--cc=kaushal.modi@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.