GNU bug report logs - #41006
26.3; regular expressions documentation

Previous Next

Full log

View this message in rfc822 format

From: Richard Stallman <rms <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: mattiase <at> acm.org, stefan <at> marxist.se, 41006 <at> debbugs.gnu.org, rtm443x <at> googlemail.com
Subject: bug#41006: 26.3; regular expressions documentation
Date: Fri, 08 May 2020 23:53:58 -0400

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  > 1. Some high-level description of regexps - an idea
  >    of what they are and what you can use them for.
  > 2. How to use them to match/search: regexp search.
  > 3. Details of what they are - syntax, etc.

This suggestion is rather vague because it doesn't relate to
the node structure.  The node structure is crucial for a manual in Info.

The overall node for regexps, Regular Expressions, should start with a
brief introduction.  (Every node that has subnodes should start with a
brief introduction.)  It could be as much as 10 or 12 lines.

But the subnode menu should fit on the screen, so more than 10 or 12 lines
is too many.

The node intro normally does NOT start to teach those topics; it only
says what the topics are.  We can't describe very much of regexp
syntax there.

It could say a little bit about some very simple regexps, but no more.

So the first subnodes need to describe how to write a regexp.

I am thinking about the Lisp Manual here.

-- 
Dr Richard Stallman
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.