Re: [doc] Inconsistent indentation of rdoc entries ?

On Tue, 6 Jul 2004, Dave Thomas wrote:
> >
> > Personally I prefer alternative 1) above.
> > When 2 or more spaces are used, it becomes increasingly difficult to
> > see visually how many spaces should actually be used, for example in
> > a description with several paragraphs with normal text, and
> > interspersed examples (like Array#pack).
>
> In general I have tried to have directives (such as call-seq) line up
> with the body text, and code examples indented 2 spaces past that.
> However, I know that the stuff in there now isn't 100% consistent.
> Partly that's lazy editing on my part (the conversion from the original
> TeX was at times a tad ugly), and partly that's just a set of
> oversights.
>

I understand.

> Apart from fixing errors, I'm not sure it's worth anyone's time to go
> through and change existing entries just to reset margins. However, if
> anyone is already editing an entry and wants to make the margins
> consistent, that'd be great..
>
>

That seems like a reasonable approach.

One reason I asked was that I didn't know which of all the available
indentation styles I should use when I changed an entry. Keeping the
existing indentation in all cases didn't "feel right". But in order
to change it, I had to have some idea of what was considered right.

/Johan Holmberg