[TYPO3-50-general] Documentation update and new features: Object Framework

Peter Beernink p.beernink at drecomm.nl
Mon Jan 5 22:47:31 CET 2009


Hi Robert,

I've just finished reading the documentation on the Object Framework.
First of all, great job. I must say it was very good readable and understandable.

I've a couple of things which caught my eye or where not completely clear to me (or perhaps I have overlooked some things or got it wrong).
Some things might be nitpicking, but then again, you also asked to look for spelling mistakes :)

I'll try to point them out as clearly as possible.

1) In the example of the addressbook class you point out that instances of the class \F3\Address\Adress should not be unique. Shouldn't there be a @scope prototype added to the class in that case?
2) In the text surrounding the example and in the example code, Address and Adress (Note the single and double d) are used inconsequently, the same goes for the double s.
3) Just above example 1.5:
     [...] there is only one special method which is provided by PHP's own means [...] 
   I think you meant [...] method which is _not_ provided by [...]
4) A minor typo: just below the Object names and types
     [...] which asks for a object with certain [...]
   This should be [...] asks for an object with [...]
5) In the examples on the configuration (1.7, 1.12, 1.13, 1.22 and 1.24) you mention F3\MyPackage\Baz, shouldn't this be F3\MyPackage\BarInterface? This to be more consistent.
6) Also about the consistency perhaps Example 1.9 also should have the propery 'bar' instead of 'someLogger'
7) A question about Example 1.20. Perhaps I did miss something, but does it matter in which package the yaml file is placed?
8) An other minor typo: just below example 1.29
     [...] third argument and the optional fourth parameter is automatically built [...]
   I believe this is should be a plural, but I can be wrong here.

One thing in general, perhaps some more difference in style between the different headers (h3, h4) and examples might increase the readability although I didn't find it to be annoying.

As I'm currently into the documentation I've also taken the liberty to read the other documentation (that is Introduction and Package).
I have also one minor thing on the Package documentation:

1) In the description of the Resources -> Media, the Media/Public. Shouldn't that be reversed, or do I read this wrong.


I hope that you find the feedback useful.
If you have any modifications in this or other parts of the documentation, just let me know as I'll be happy to look them through, and learn while doing that.

Greets,

Peter


More information about the TYPO3-project-5_0-general mailing list