[Lazarus] Documentation style

[Howard Page-Clark]

On 23/7/11 1:20, Hans-Peter Diettrich wrote:
> During the development of the doc tracker I stumbled over several issues:
>
> The English wording often violates my feeling for the language. Can some
> native English speakers proofread the documentation, and correct
> stylistic flaws?

<snip>
> I also can assign doc files to those people, which are willing to
> proofread the documentation, so that we can avoid duplicate work.

I'm a native English speaker, and I'm willing to proofread 
documentation, and make suggestions for improvements. However, I suspect 
it is almost an endless task, and probably too much for one person to 
undertake (although the ideal would be for one English-speaker to 
undertake this, to get a consistent 'house style' and consistent 
spelling [UK > US English?]).

Several questions arise immediately. Where precisely are the original 
documents? How can I (or anyone else) be trusted to edit them correctly?
What about formatting style, indenting etc. for code examples? It would 
be good to have consistency here too. I notice quite a lot of 
fpc/Lazarus source is quite terse:

[ result:=i*trunc(x/y); rather than    result := i * Trunc( x/y ); ]

yours

Howard