chevah / geck

Chevah Garden Of Eden Creation Kit
http://geck.chevah.com/
0 stars 1 forks source link

Text clean-up for all the documents. #28

Closed lesingerouge closed 7 years ago

lesingerouge commented 8 years ago

Scope

Corrections to the text and small additions and clarifications to the parts that needed it.

Why we got into this (5 whys)

Because there were a lot of small mistakes. Because those mistakes looked a bit bad. Because typos look bad. Because some of the explanations needed some context. Because life evolves and docs should just keep up.

Changes

Corrected grammar issues (missing "a" and "the") and typos (additional "s" or other characters). Added one ammendment to Rule nr. 3. Extended the section related to Python Abstract classes with some explanations regarding the differences between Twisted and classic Python.

How to try and test the changes

reviewers: @robi-net

Please check that the proposed additions to the content fit with the general view.

adiroiban commented 8 years ago

Many thanks for this PR :)

a lot of this content was just 1AM brain dump so it is poorly written ... but now it looks much better. Thanks!

the abstract class, is just a think that we agreed upon to organize the previous methods that we had and which were raising NotImplementedError ... we should not replace all decorators with abstract classed and in fact we should use them as less as possible and instead of inheriting from an abstract class we should look at decorators / delegators / proxy and composition

Also, the abstract classes as described here are not a Twisted thing :)

Please check my inline comments and merge.

Thanks again! Great work!

adiroiban commented 8 years ago

@lesingerouge do you still want to work on this?

I would like to merge this soon as there is a lot of good stuff in this PR and it sitting here for more than 2 weeks

lesingerouge commented 8 years ago

@adiroiban yes, will finish this week.

adiroiban commented 7 years ago

will close this as Daniel no longer has time to work on this.