Remove "##" from a comment to require

[tompng]

In RDoc, comment that starts with "##" is a metaprogramming method definition. If it's not a metaprogramming method definition, "##" shouldn't be used.

What was the end-user or developer problem that led to this PR?

In RDoc's experimental ruby parser, comment below will add a "rubygems/defaults/operating_system" method and "unknown" method to the documentation.

##
# comment
require "rubygems/defaults/operating_system"

##
# comment
require "rubygems/defaults/#{RUBY_ENGINE}"

Reason:

class A
  ##
  # If a comment starts with '##', it is a metaprogramming method.
  # If `:method: methodname` directive is not used, RDoc uses the first
  # symbol/string argument as method name to be documented.
  define_metaprogramming_method "abc", metaprogramming_arguments

  ##
  # Defines method "foo/bar" in both released RDoc and in experimental RDoc parser
  require_relative "foo/bar"

  ##
  # Defines method "foo/baz" only in experimental RDoc parser.
  # Released RDoc somehow ignores this case for unknown reason.
  require "foo/baz"
end

This pull request will prevent it.

What is your fix for the problem, implemented in this PR?

Make sure the following tasks are checked

• Describe the problem / feature
• Write tests for features and bug fixes
  • not needed
• Write code to solve the problem
  • only comment deletion
• Make sure you follow the current code style and write meaningful commit messages without tags

[hsbt]

@tompng Thanks.

In RDoc, comment that starts with "##" is a metaprogramming method definition. If it's not a metaprogramming method definition, "##" shouldn't be used.

Is it documented behavior?

[tompng]

Is it documented behavior?

Yes. Documented here https://ruby.github.io/rdoc/RDoc/Parser/Ruby.html#class-rdoc-parser-ruby-metaprogrammed-methods

To pick up a metaprogrammed method, the parser looks for a comment starting with ‘##’ before an identifier:

##
# This is a meta-programmed method!

add_my_method :meta_method, :arg1, :arg2

The parser looks at the token after the identifier to determine the name, in this example, :meta_method. If a name cannot be found, a warning is printed and ‘unknown’ is used.

[hsbt]

I see. Thanks!