GNU bug report logs - #33541
26; Doc string of `align-regexp'

Previous Next

Full log

Message #14 received at 33541 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Phil Sainty <psainty <at> orcon.net.nz>
Cc: 33541 <at> debbugs.gnu.org, drew.adams <at> oracle.com
Subject: Re: bug#33541: 26; Doc string of `align-regexp'
Date: Thu, 29 Nov 2018 09:23:36 +0200

> Date: Thu, 29 Nov 2018 12:22:18 +1300
> From: Phil Sainty <psainty <at> orcon.net.nz>
> Cc: 33541 <at> debbugs.gnu.org
> 
> I think the docstring is clear, provided that you read all of it; but
> it could undoubtedly be improved, especially as this is a slightly
> fiddly command to get to grips with.
> 
> Perhaps your concern could be addressed by tweaking the paragraph
> starting "REGEXP must contain at least one parenthesized subexpression"
> so that it says:
> 
> "Non-interactively, REGEXP must contain at least one parenthesized...."
> 
> (which strictly speaking is perhaps less correct than what it says now,
> yet I think in practice would make things slightly clearer.)
> 
> I would also change "automatically added" to "automatically prefixed".

Patches to improve that doc string are welcome.

Previous Next

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