documentation

Note when going through the Mongoid documentation, some assumptions will be made to keep everything as brief as possible.

Model#method_name will be used for describing instance methods.

Model.method_name will be used for describing class methods.

When in the code examples an all lowercase model name is used it is there to imply a document of that class had been created previously in the example:

person #=> Implies a Person document had been instantiated already.

Comments above a line in a code example alert to what is occurring on the next line, and potentially all subsequent lines up to the next empty line:

# Make it rain fool!
person.make_it_rain
person.show_me_the_money!

Indication of being on a command prompt will be indicated by a $.

$ rails new leisure-suit-larry

All Ruby code will be using 1.9.2 syntax. Although note that Mongoid is compatible with 1.8.7, REE, and JRuby as well.

Note that the Mongoid documentation is only valid for the current release of Mongoid - we do not store historical records of releases. For more detailed information of when functionality was added or removed, please see the API documentation.