Skip to content

Set up yardlint#2625

Merged
joelhawksley merged 9 commits intomainfrom
2567-yardlint
May 5, 2026
Merged

Set up yardlint#2625
joelhawksley merged 9 commits intomainfrom
2567-yardlint

Conversation

@joelhawksley
Copy link
Copy Markdown
Member

What are you trying to accomplish?

This PR adds @mensfeld's https://github.com/mensfeld/yard-lint to the project and cleans up a few rules that only had a few violations. I'll try to tidy up more of them later, but this will prevent us from getting any worse ❤️

Closes #2567

Remove empty trailing comment line in Slot#method_missing docs
and enable the validator.
Convert 'Note:' to @note YARD tag in render_preview docs
and enable the validator.
Fix YARD tag ordering: @param before @return in Compiler,
@note after @return in TestHelpers, and enable the validator.
Fix @param type position in Compiler#find_templates_for to use
'@param name [Type]' instead of '@param [Type] name', and enable
the validator.
Fix invalid Symbol[] type annotations to Array<Symbol> in
TestHelpers#with_variant and #with_format, and enable the validator.
Already passes after Symbol[] -> Array<Symbol> fix in previous commit.
@joelhawksley joelhawksley merged commit 8c76bd3 into main May 5, 2026
19 checks passed
@joelhawksley joelhawksley deleted the 2567-yardlint branch May 5, 2026 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Set up yard-lint

1 participant