From: "Drew Adams" <drew.adams@oracle.com>
To: "'Stefan Monnier'" <monnier@iro.umontreal.ca>
Cc: 7217@debbugs.gnu.org
Subject: bug#7217: 24.0.50; no doc strings for regexp-opt functions
Date: Fri, 15 Oct 2010 13:31:00 -0700 [thread overview]
Message-ID: <CE165D82D9E448D5A7FBB7C4A1DE8FA5@us.oracle.com> (raw)
In-Reply-To: <jwvvd53442f.fsf-monnier+emacs@gnu.org>
> > Please provide doc strings for the so-called "workhorse" regexp-opt
> > functions. They are important enough for users that I see
> > them used in 3rd-party libraries.
>
> > regexp-opt-group
> > regexp-opt-charset
>
> Maybe regexp-opt-charset makes sense in 3rd party libraries (the same
> functionality is also re-implemented in rx.el and sregex.el,
> IIRC), but I can't think of any reason to use regexp-opt-group.
>
> So I agree for regexp-opt-charset and would also like to see
> it used in rx.el and friends,
Sounds good to me. r-o-c was in fact the one I came across in a 3rd-party
library - I should have said "it", not "them".
(However, I cannot see any reason _not_ to give doc strings to both. I
understand that you feel that way about "internal" functions. I don't. Doc
strings make it easier to read code. If a block comment at the beginning of a
function to describe it is useful for reading the code, then turn it into a doc
string so it becomes easier to access. In the 1980s there was also a desire to
save some space/memory, but that should no longer be a consideration wrt doc
strings.)
next prev parent reply other threads:[~2010-10-15 20:31 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-10-14 15:24 bug#7217: 24.0.50; no doc strings for regexp-opt functions Drew Adams
2010-10-15 20:05 ` Stefan Monnier
2010-10-15 20:31 ` Drew Adams [this message]
2010-10-17 19:01 ` Stefan Monnier
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=CE165D82D9E448D5A7FBB7C4A1DE8FA5@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=7217@debbugs.gnu.org \
--cc=monnier@iro.umontreal.ca \
/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.