block / block/elasticgraph

Look into adopting yard-lint

Open
#913 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Ruby
Stars
88
Forks
36
Avg merge
5d 10h
Merged PRs (30d)
18

Description

https://mensfeld.pl/2025/11/yard-lint-ruby-documentation-linter/
https://github.com/mensfeld/yard-lint

We already attempt to lint some of this in a janky way:

https://github.com/block/elasticgraph/blob/8820a5afa7039972fa05b1568254dad50a4a2d09/config/site/Rakefile#L70-L103

https://github.com/block/elasticgraph/blob/8820a5afa7039972fa05b1568254dad50a4a2d09/config/site/Rakefile#L565-L581

https://github.com/block/elasticgraph/blob/8820a5afa7039972fa05b1568254dad50a4a2d09/config/site/Rakefile#L606-L610

This looks way better, though.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.