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

by

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.

More Related Contents:

  1. Ruby syntax error, unexpected tIDENTIFIER, expecting end-of-input
  2. Ruby: String Comparison Issues
  3. How to pass command line arguments to a rake task
  4. Ruby 2.0.0p0 IRB warning: “DL is deprecated, please use Fiddle”
  5. Ruby metaclass confusion
  6. What are all the common ways to read a file in Ruby?
  7. Ruby: kind_of? vs. instance_of? vs. is_a?
  8. What exactly is `&:capitalize` in Ruby?
  9. How do I get the match data for all occurrences of a Ruby regular expression in a string?
  10. What does __FILE__ mean in Ruby?
  11. Why isn’t the eigenclass equivalent to self.class, when it looks so similar?
  12. Ruby Hash with duplicate keys?
  13. Performance of Arrays and Hashes in Ruby
  14. Ruby Regular expression to match a url [duplicate]
  15. Installing Jekyll without root
  16. How can I update Ruby version 2.0.0 to the latest version in Mac OS X v10.10 (Yosemite)?
  17. Equivalent of cURL for Ruby?
  18. What is the difference between map, each, and collect? [duplicate]
  19. Does Ruby perform Tail Call Optimization?
  20. Running a command from Ruby displaying and capturing the output
  21. In Rails, how to add a new method to String class?
  22. Why isn’t self always needed in ruby / rails / activerecord?
  23. Chrome 62 and Flash
  24. Interpolating a string into a regex
  25. Ruby: Installing rmagick on Ubuntu
  26. Better ruby markdown interpreter?
  27. Ruby gem for finding timezone of location [closed]
  28. Ruby local variable is undefined
  29. Understanding Ruby and OS I/O buffering
  30. Rake “already initialized constant WFKV_” warning

Leave a Comment