bug#17707: 24.4.50; doc string of `align-newline-and-indent'

bug#17707: 24.4.50; doc string of `align-newline-and-indent'

[Drew Adams]

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@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''

bug#17707: 24.4.50; doc string of `align-newline-and-indent'

[Lars Ingebrigtsen]

Drew Adams <drew.adams@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

bug#17707: 24.4.50; doc string of `align-newline-and-indent'

[Drew Adams]

> >   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?

bug#17707: 24.4.50; doc string of `align-newline-and-indent'

[Lars Ingebrigtsen]

Drew Adams <drew.adams@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

bug#17707: 24.4.50; doc string of `align-newline-and-indent'

[Drew Adams]

> >> > 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.