lsegal on master
Support i18n in tag text Merge pull request #1169 from k… (compare)
Value.new
is your library's Value
class. That said, you can write a YARD plugin to generate whatever information you want in the registry, effectively treating it like a struct in the same way YARD does it: https://github.com/lsegal/yard/blob/master/lib/yard/handlers/ruby/class_handler.rb#L72 just don't expect any IDE integration even with that logic.
I'm creating an instance of a DSL class, then adding a singleton method to it.
dsl_instance = DSLClass.new
def dsl_instance.a_callback_method
# code
end
Yard throws warnings. Anyway to doc the method? Thanks.
@example
under list item? Output: http://www.rubydoc.info/github/bbatsov/RuboCop/RuboCop/Cop/Style/BracesAroundHashParameters Code: https://github.com/bbatsov/rubocop/blob/master/lib/rubocop/cop/style/braces_around_hash_parameters.rb#L6
@example DESCRIPTION TEXT
values
gem, such as Table = Value.new(:legs)
, as a class instead of like a normal constant? I've seen there were previous requests for this same feature for Structs, which would work analogously. A @!class
directive perhaps?
**options
may no longer be a hash - and even now that detail might be better off considered an implementation detail. I wonder if when a user writes **options
we could explicitly mark it as "Keyword Arguments", for example. Anyway, just a discussion point that as we head towards Ruby 3.0, may become more important.
@see
" support, so that my references to related methods could be described.
# @see Endpoint.udp udp - invoked when parsing a URL with the udp scheme: "udp://127.0.0.1"
Note the repetition of the udp
word.
# @param options keyword arguments passed straight through to {#initialize}
.sort_by! { |file_path| [file_path.count('/'), file_path] }
/a/baaaaaaaaaaaaaa.rb
and /a/b/a.rb
the more nested will be actually first