Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style/Documentation: Missing top-level class documentation comment. #2

Open
oklahomabigdog opened this issue Sep 11, 2020 · 1 comment
Labels
question Further information is requested

Comments

@oklahomabigdog
Copy link

oklahomabigdog commented Sep 11, 2020

This forces every class to have comment documentation placed above the class name. I don't hate this rule I just made this an issue so it could be discussed.

#
# This class does some stuff.
class SomeClass

This one is simple: Enabled or Disabled.

@evanthegrayt
Copy link
Contributor

evanthegrayt commented Sep 14, 2020

I'm 50/50 on this. These are always tough with rails because things like controllers/models/etc are standard, but I'd definitely want things like concerns and classes in lib/ to be fully documented.

I guess it makes sense to just disable it, for this reason. We'll just need to be diligent about commenting when it makes sense.

@evanthegrayt evanthegrayt added the question Further information is requested label Sep 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants