pavlitsky / vscode-yard

YARD comments generator for Visual Studio Code
https://yardoc.org/
MIT License
23 stars 3 forks source link

Doesn't generate method documentation for methods that aren't alphanumeric #10

Closed boc-tothefuture closed 5 months ago

boc-tothefuture commented 3 years ago

Thanks for creating this plugin!

I have noticed that the plugin doesn't generate method documentation if the method isn't alphanumeric. For example

def |(other)

end

If you ask the plugin to generate method documentation using the hotkey, nothing happens.

pavlitsky commented 3 years ago

@boc-tothefuture can you please double-check it? When I press the hotkey I get this method documented:

  #
  # <Description>
  #
  # @param [<Type>] |other <description>
  #
  # @return [<Type>] <description>
  #
  def |(other)

  end

|other parameter name should be fixed though, but it works. I checked it on two different machines.

ahangarha commented 5 months ago

I can generate docs, too.

I think this issue is already resolved.