Ability to override class method via Yard docs

[williamtstanley]

I have a base class that is often extended:

class ApplicationPlan
  def self.execute(*args)
    new.execute(*args)
  end

  def self.to_proc
    proc { |*args| execute(*args) }
  end

  class << self
    alias_method :call, :execute
  end
end

Each use of this class is defined like:

class SomePlan < ApplicationPlan
  def execute(some_arg)
    # ...
  end
end

And then used like: SomePlan.execute(some_value)

I would like to be able to give ide hints via Yard definitions but I haven't found a way that works re @overload || @!override is there a way to give autocomplete / documentation to users of a Plan? right now all we get is execute(*args)

I had hoped I could get something like:

class SomePlan < ApplicationPlan
      # @!override self.execute
      #   @param shipping_charges [Array<ShippingInfo>]
      #   @return [Result<Array<Billing::Charge>]
      
      #...
end

Working but it doesn't

[williamtstanley]

Played with it some more and it looks like if I do:

      # @!method self.execute
      #   @param charges [Array<Charges>]
      #   @return [Result<Billing::Charge>] 

gets me what I was hoping for

[williamtstanley]

I would love to be able to document the execute method and then do something like

class ApplicationPlan
  # @see #execute
  def self.execute(*args); end
end

and have that all "Just Work":tm: