Detach RBI header comment from top-level node (when generating YARD docs) #1885
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.