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
- RBS parser drops members with a visibility modifier, ignores `private` sections, and misnames `def self?.` methods
- RBS parser reads `module X = Y` as a module body, misplacing the declarations after it, and drops `class X = Y`
- RBS parser drops method aliases: the `:alias` statements it makes have no handler
- RBS parser doesn't close a namespace at an `end` followed by a comment, misplacing the declarations after it
- RBS method handler gives a generic method, or one with an optional block, `@return [void]` and no `@param` or `@yield` tags
- RBS parser keeps a mixin's type arguments in its name, so `include Enumerable[E]` never resolves and the mixin's methods are lost
- Fix stack overflow: Redux
- html: don't resolve links within code block
- Sidebar navigation hidden on small screens with no way to open it
- No general grouping syntax for unions nested inside tuples, intersections, etc.
- Docs
- YARD::Handlers::Ruby::ClassHandler#parse_data_superclass
- YARD::Handlers::Ruby::StructHandlerMethods#create_readers
- YARD::Server.clean_path
- YARD::Tags::TypesExplainer::Parser#parse_until
- YARD::Handlers::Ruby::StructHandlerMethods#register_docstring
- YARD::Handlers::Ruby::StructHandlerMethods#register_struct_member_method
- YARD::Handlers::Ruby::StructHandlerMethods#type_tag_for_member
- YARD::Handlers::Ruby::StructHandlerMethods#parameter_tag_for_member
- YARD::Tags::TypesExplainer::LiteralType#to_s
- YARD::Server::StaticCaching#cache_path