Add documentation & make code code-style compliant.

Question

Add documentation & make code code-style compliant.

Closed this issue 11 years ago · 7 comments

xairy commented 11 years ago

Bitbucket: https://bitbucket.org/bmteam/pink-ponies/issue/44
Originally Reported By: Alexander Konovalov
Originally Created At: 2013-04-12T14:26:14.164

Answer 1 · 2014-01-02T21:29:20.000Z

Even overdid (see #58). :)

Original Comment By: Andrey Konovalov

Answer 2 · 2014-01-02T21:29:20.000Z

Ah OK, we were talking about different style checkers then.

Original Comment By:

Answer 3 · 2014-01-02T21:29:21.000Z

Yes, it does require it =) Every method and every field has to be documented to pass stylecheck.

Original Comment By: Alexander Konovalov

Answer 4 · 2014-01-02T21:29:21.000Z

Does the style checker require documentation?
If not - I think it's better to first make the existing code style checker clean, and then add documentation on "as needed" basis.

Original Comment By:

Answer 5 · 2014-01-02T21:29:21.000Z

Well, you can't make code compliant with code-style unless you add
documentation everywhere. And if you add documentation you'll complete 95%
of the code-style issue. Thus they are basically the same issue.

Original Comment By: Alexander Konovalov

Answer 6 · 2014-01-02T21:29:21.000Z

What was the point in dup'ing an "A" issue to a "B and A" issue?
I'd rather keep "B" and "A" separate as it's usually easier to track progress with disjoint tasks.

Original Comment By:

Answer 7 · 2014-01-02T21:29:21.000Z

Issue #35 was marked as a duplicate of this issue.

Original Comment By: Alexander Konovalov