* bug#7217: 24.0.50; no doc strings for regexp-opt functions
@ 2010-10-14 15:24 Drew Adams
2010-10-15 20:05 ` Stefan Monnier
0 siblings, 1 reply; 4+ messages in thread
From: Drew Adams @ 2010-10-14 15:24 UTC (permalink / raw)
To: 7217
emacs -Q
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
To understand these functions, a user needs to read the block comment
for each. Please move this info to a doc string.
In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
of 2010-09-20 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4) --no-opt --cflags
-Ic:/imagesupport/include'
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#7217: 24.0.50; no doc strings for regexp-opt functions
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
0 siblings, 1 reply; 4+ messages in thread
From: Stefan Monnier @ 2010-10-15 20:05 UTC (permalink / raw)
To: Drew Adams; +Cc: 7217
> emacs -Q
> 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,
Stefan
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#7217: 24.0.50; no doc strings for regexp-opt functions
2010-10-15 20:05 ` Stefan Monnier
@ 2010-10-15 20:31 ` Drew Adams
2010-10-17 19:01 ` Stefan Monnier
0 siblings, 1 reply; 4+ messages in thread
From: Drew Adams @ 2010-10-15 20:31 UTC (permalink / raw)
To: 'Stefan Monnier'; +Cc: 7217
> > 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.)
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#7217: 24.0.50; no doc strings for regexp-opt functions
2010-10-15 20:31 ` Drew Adams
@ 2010-10-17 19:01 ` Stefan Monnier
0 siblings, 0 replies; 4+ messages in thread
From: Stefan Monnier @ 2010-10-17 19:01 UTC (permalink / raw)
To: Drew Adams
Should be fixed now,
Stefan
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2010-10-17 19:01 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
2010-10-17 19:01 ` Stefan Monnier
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).