Why are methods in Ruby documentation preceded by a hash sign?

Question

When I see any Ruby method printed in text, it usually appears as:

Class#method

or

#method

Now, I would u

Answer 1

From the rdoc docs (emphasis mine):

Names of classes, source files, and any method names containing an underscore or preceded by a hash character are automatically hyperlinked from comment text to their description.

Answer 2

Note that the convention is:

Class#method

rather than

object#method

In code you would have object.method, if object was an instance of class. The # convention is not used in code.

From the RDoc documentation:

Use :: for describing class methods, # for describing instance methods, and use . for example code.