FreeLists / haiku-doc / [haiku-doc] Re: RFC on first steps on List.dox

["Niels Reedijk" <niels.reedijk@xxxxxxxxx>]

Hi David,



> Attached is a simple "svn diff List.dox" piped to a text-file. I'm going with the 
> OSS-mantra of "release early, release often" and I'm asking for comments on what you 
> think about what I've written. Things like language, clarity and you can also help me out deciding 
> if I should add myself as an author instead of a proof-reader. The way I figure I'm rewriting large 
> parts of it but I want to avoid stepping on any toes in the process. :)
First of all, could you name your files something like List.dox.diff
or List.dox.070521.patch (both .diff or .patch extension will be
great). Secondly, have you opened the file in a text editor that has
an 80 character limit and then saved it? It seems that your diff is
currently invalid because some of the lines have been wrapped.

+ * Authors:
+ * Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
+ *
+ * Proof-reading:
+ * David Weizades <ddewbofh@xxxxxxxxxxx>

We decided on using Proofreaders (as I recall), even if there is only
one. I think proofreader does not need a '-'. I've updated the API
guidelines yesterday, BTW, to reflect that.

+  BList contains a list of items that will grow and shrink depending on how
+  many items are in it. So you will not have to do any of the memorymanagement

I don't know if memory management should be one word.

The rest of the changes look good to me, though I currently would
classify them as proofreading rather than authorship, in a sense that
you are merely rewording things rather than adding new information.

Keep up the good work, I'm looking forward to seeing more of it.

Niels