plugin to remove rubcop comments

12 views
Skip to first unread message

l...@later.com

unread,
Feb 28, 2018, 7:42:39 PM2/28/18
to YARD
Is there a plugin to remove the rubocop:disable comments from the generated docs? If not, any guidance on where I would look to writing my own to accomplish this?

Les

Loren Segal

unread,
Mar 5, 2018, 9:52:32 PM3/5/18
to yar...@googlegroups.com

Hi Les,

Put 2 newlines between the disable comment and your docstring or declaration and YARD don't pick it up.

    # rubocop:disable


    # docstring here
    def foo; end


On 2/28/2018 4:42 PM, l...@later.com wrote:
Is there a plugin to remove the rubocop:disable comments from the generated docs? If not, any guidance on where I would look to writing my own to accomplish this?

Les
--

---
You received this message because you are subscribed to the Google Groups "YARD" group.
To unsubscribe from this group and stop receiving emails from it, send an email to yardoc+un...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

l...@later.com

unread,
Mar 6, 2018, 10:41:28 AM3/6/18
to YARD
Thanks you!!!

l...@later.com

unread,
Mar 6, 2018, 2:32:31 PM3/6/18
to YARD
Actually, I just realized this probably isn't a great option for rubocop. One of the standard cops is to prevent multiple blank lines in a row.

Loren Segal

unread,
Mar 6, 2018, 3:23:08 PM3/6/18
to yar...@googlegroups.com, l...@later.com
Actually good news!

When I said two newlines I really meant one empty line, not 2 empty lines.
Reply all
Reply to author
Forward
0 new messages