square/cane

"Classes not documented" gives false positives

Closed this issue · 1 comments

I use the magic_encoding gem to automatically insert 'magic' UTF-8 comments into all of my Ruby files.

All of the files that have had a magic encoding line inserted are reported by cane to be documented, which they definitely are not. It looks like cane is fooled by simply having a comment on the line preceding the declaration of a class.

magic encoding line:

# -*- encoding : utf-8 -*-

Hrmm, probably makes sense to just make cane aware of the different magic comments and ignore them. I'll put a fix together.