bug#8287: 24.0.50; regexp-builder, rx, sregex: (a) in manuals, (b) in action

[Lars Ingebrigtsen]

"Drew Adams" <drew.adams@oracle.com> writes:

> 1. Only `re-builder', not `regexp-builder', is indexed in the Elisp
> manual.  This is incomplete and backwards - users will look for "regexp"
> before "re-" when looking for help with regexps.

There's already a @cindex to "regexp" in the same node, so that seems
unnecessary.

> 2. There is no explanation of this command in either manual.  Node
> `Regular Expressions' of Elisp just mentions it in passing, with no
> help.  It says that the command provides "a convenient interface"
> without providing any explanation of that nifty interface or how to use
> it.  The Emacs manual doesn't even mention the command.

@findex re-builder
@cindex regular expressions, developing
  For interactive development of regular expressions, you
can use the @kbd{M-x re-builder} command.  It provides a convenient
interface for creating regular expressions, by giving immediate visual
feedback in a separate buffer.  As you edit the regexp, all its
matches in the target buffer are highlighted.  Each parenthesized
sub-expression of the regexp is shown in a distinct face, which makes
it easier to verify even very complex regexps.

Looks fine now, at least...

> See also bug #8286, about the hopeless doc string.
>
> 3. There is no real doc for `re-builder' - no help for users, including
> after they actually try to use the command.  `C-h m' in buffer
> *RE-Builder* simply lists the key bindings.  To understand anything
> about this "convenient interface" users will need to drill down from the
> list of key bindings and check the doc for each command.  And even then
> they will discover nothing of any real help AFAICT.

Chong fixed this in 2011, apparently.  Closing.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no