New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Don't document methods with malformed parameters #3

Open

pavlitsky opened this issue Oct 18, 2018 · 1 comment

Owner

pavlitsky commented Oct 18, 2018 •

edited

Add basic validation for method's parameters. If they're invalid then don't document either entire method or only skip its parameters.

Bad params examples:

def foo(bar, baz qux)
end

def foo ; end

Owner Author

pavlitsky commented Apr 15, 2024

Also fix param name in this case, it should parse as other, not |other.

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

  end

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment