Mailer documentation cleanup #1413
Conversation
…ntation-cleanup Mailer documentation cleanup
| @@ -42,6 +43,6 @@ def self.mime_type(mime, fallback=:plain) | |||
| "text/plain" => :plain, | |||
| "text/xml" => :xml | |||
| } | |||
| end # Mime | |||
| end # Mailer | |||
| end # Padrino | |||
There was a problem hiding this comment.
Thanks for such a hard work @matthias-guenther! :) However, I'd still leave these kind of ending comments as they give you a hint of the section you were at. Thoughts @padrino/core-members?
There was a problem hiding this comment.
I don't like these ending comments. If you're confused, what section you are, you should refactor.
There was a problem hiding this comment.
I don't like them either - if you are using rubymine or vim for hacking, they have wonderful folding which makes it very easy to get an overview of the whole structure of the file.
There was a problem hiding this comment.
I don't really add them to my day to day code. Just found them as a common practice throughout Padrino's code and thought they might have been useful for some other people. That's why I was asking :). Your point is valid though.
There was a problem hiding this comment.
Okay, then let's wait for the opinions of other persons. If there are more votes "Pro comments" I will add them again!
There was a problem hiding this comment.
End comments often help us, but these sometimes lead to verbose code.
I think these have merit and demerit.
As usual: A documentation cleanup of the mailer component.
Cheers Matthias