GNU bug report logs - #17707
24.4.50; doc string of `align-newline-and-indent'

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 17707 in the body.
You can then email your comments to 17707 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.4.50; doc string of `align-newline-and-indent'
Date: Thu, 5 Jun 2014 14:21:59 -0700 (PDT)

Doc string:

  A replacement function for `newline-and-indent', aligning as it goes.

Aligning how?  Aligning what?  With respect to what?

Please spend some time to come up with a description of _what this
function does_.  In addition to indenting, it does some aligning - fine.
Aligning what to what?  How? (I.e., what does "aligning" mean in this
context?)

In GNU Emacs 24.4.50.1 (i686-pc-mingw32)
 of 2014-06-01 on ODIEONE
Bzr revision: 117212 michael.albinus <at> gmx.de-20140601104945-g88x0mwrxorz302h
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/Devel/emacs/snapshot/trunk
 --enable-checking=yes,glyphs 'CFLAGS=-O0 -g3'
 LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
 -Ic:/Devel/emacs/include''

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 17707 <at> debbugs.gnu.org
Subject: Re: bug#17707: 24.4.50; doc string of `align-newline-and-indent'
Date: Fri, 29 Apr 2016 22:14:34 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> Doc string:
>
>   A replacement function for `newline-and-indent', aligning as it goes.
>
> Aligning how?  Aligning what?  With respect to what?
>
> Please spend some time to come up with a description of _what this
> function does_.  In addition to indenting, it does some aligning - fine.
> Aligning what to what?  How? (I.e., what does "aligning" mean in this
> context?)

I've now made the doc string mention that it uses `align' to do
alignment.

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

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 17707 <at> debbugs.gnu.org
Subject: RE: bug#17707: 24.4.50; doc string of `align-newline-and-indent'
Date: Fri, 29 Apr 2016 15:24:45 -0700 (PDT)

> >   A replacement function for `newline-and-indent', aligning as it goes.
> >
> > Aligning how?  Aligning what?  With respect to what?
> >
> > Please spend some time to come up with a description of _what this
> > function does_.  In addition to indenting, it does some aligning - fine.
> > Aligning what to what?  How? (I.e., what does "aligning" mean in this
> > context?)
> 
> I've now made the doc string mention that it uses `align' to do
> alignment.

OK, but what alignment?  What does it align with what?

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 17707 <at> debbugs.gnu.org
Subject: Re: bug#17707: 24.4.50; doc string of `align-newline-and-indent'
Date: Sat, 30 Apr 2016 00:28:04 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

>> >   A replacement function for `newline-and-indent', aligning as it goes.
>> >
>> > Aligning how?  Aligning what?  With respect to what?
>> >
>> > Please spend some time to come up with a description of _what this
>> > function does_.  In addition to indenting, it does some aligning - fine.
>> > Aligning what to what?  How? (I.e., what does "aligning" mean in this
>> > context?)
>> 
>> I've now made the doc string mention that it uses `align' to do
>> alignment.
>
> OK, but what alignment?  What does it align with what?

`align' presumably explains that sufficiently.

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

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 17707 <at> debbugs.gnu.org
Subject: RE: bug#17707: 24.4.50; doc string of `align-newline-and-indent'
Date: Fri, 29 Apr 2016 15:56:29 -0700 (PDT)

> >> > Please spend some time to come up with a description of _what this
> >> > function does_.  In addition to indenting, it does some aligning -
> >> > fine.
> >> > Aligning what to what?  How? (I.e., what does "aligning" mean in this
> >> > context?)
> >>
> >> I've now made the doc string mention that it uses `align' to do
> >> alignment.
> >
> > OK, but what alignment?  What does it align with what?
> 
> `align' presumably explains that sufficiently.

Do you think it does, for what `align-newline-and-indent' does?
If so, can you describe what it does for `align-newline-and-indent'?

If no, then you, like I, are wondering.  If yes, then please
add that description to the doc string.

Previous Next

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