This is the mail archive of the
guile@sourceware.cygnus.com
mailing list for the Guile project.
Re: Guile docstrings---should Guile code be ANSI C compatible?
- To: mstachow at alum dot mit dot edu, gjb at cs dot washington dot edu, mdj at nada dot kth dot se
- Subject: Re: Guile docstrings---should Guile code be ANSI C compatible?
- From: Roland Orre <orre at nada dot kth dot se>
- Date: Sat, 15 Jan 2000 03:28:27 +0100 (MET)
- CC: guile at sourceware dot cygnus dot com
- Reply-to: orre at nada dot kth dot se (Roland Orre)
Docstrings containing explicit linebreaks should not be used as they
may not give the desired result and is not future safe. I may want
to adapt the docstring presentation to an arbitrary text width.
I'm completely buying Maciej's argument here:
> Personally I think the docstrings shouldn't contain explicit linebreaks
> and should be formatted by whatever is generating the ready-to-display
> output. Then they could either be written as one long line, or using the
> autoconcatenation feature:
On the other hand, linebreaks could possibly be used to indicate
a new paragraph in case its needed in the future.
My suggestion therefore is, remove all explicit line breaks now and make
the code as clean as possible.
Best regards
Roland