yard
https://github.com/lsegal/yard
Ruby
YARD is a Ruby Documentation tool. The Y stands for "Yay!"
Triage Issues!
When you volunteer to triage issues, you'll receive an email each day with a link to an open issue that needs help in this project. You'll also receive instructions on how to triage issues.
Triage Docs!
Receive a documented method or class from your favorite GitHub repos in your inbox every day. If you're really pro, receive undocumented methods or classes and supercharge your commit history.
6 Subscribers
Add a CodeTriage badge to yard
Help out
- Issues
- Support class Foo < Data.define(:a, :b) as a documented superclass
- Sidebar navigation hidden on small screens with no way to open it
- No general grouping syntax for unions nested inside tuples, intersections, etc.
- Add intersection ("A & B") and union ("A | B" / "[A | B]") type syntax
- Anonymous collection/hash shorthand (<A>, (A), {A=>B}) documented at yardoc.org/types but not in docs/Tags.md
- globals.rb pollutes the global namespace
- Should we adopt @generic tag as a YARD standard?
- Aliki
- Add class reference to macros
- Allow using Prism for parsing
- Docs
- YARD::Templates::Helpers::Markup::HybridMarkdown#strip_fenced_indent
- YARD::Templates::Helpers::Markup::HybridMarkdown#fence_closer?
- YARD::Templates::Helpers::Markup::HybridMarkdown#parse_fence_opener
- YARD::Templates::Helpers::Markup::HybridMarkdown#parse_atx_heading
- YARD::Templates::Helpers::Markup::HybridMarkdown#heading_id
- YARD::Templates::Helpers::Markup::HybridMarkdown#strip_trailing_punctuation
- YARD::Templates::Helpers::Markup::HybridMarkdown#extract_codeblock_language
- YARD::Templates::Helpers::Markup::HybridMarkdown#code_block
- YARD::Templates::Helpers::Markup::HybridMarkdown#unindent_indented_code
- YARD::Templates::Helpers::Markup::HybridMarkdown#unindent