Detach RBI header comment from top-level node (when generating YARD docs)

[dduugg]

Motivation

See Homebrew/brew#17167
When generating YARD docs that include both source and rbi files, the tapioca header overwrites the source comments for the file's top-level node.

Implementation

YARD detaches comments that have more than two newlines of separation from the source code that follows. Thus, I've added a blank line following the file header comment, and verified that the generated yard docs do not include the header.

Tests

Tests have been updated.

[Morriar]

I'm on the fence about this change as it will clash with the Layout/EmptyLines Rubocop rule without any good way of fixing it.

Could you use this solution instead? lsegal/yard#484 (comment)

[dduugg]

Could you use this solution instead? lsegal/yard#484 (comment)

That's a mighty large hammer, which breaks the YARD contract for the other ~200k lines of Ruby in the repo. I would rather disable Layout/EmptyLines for the tapioca output path in the rubocop config (were I to lint the tapioca output at all, which kinda seems like a waste of compute). Let me know what you think.

[reitermarkus]

it will clash with the Layout/EmptyLines Rubocop rule

You could add rubocop:disable Layout/EmptyLines to the output just in case. Either way it makes more sense to ignore auto-generated files in RuboCop anyways.

[Morriar]

I guess you're right, those files are generated, we shouldn't care too much about Rubocop.

[dduugg]

Thanks for your reconsideration @Morriar, i really appreciate it ❤️