From 7cc797f1776ce8470b00b7e1dfc89f4df03749c1 Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Sun, 25 Mar 2012 20:26:35 +0200 Subject: restores example depicting the use of true or false in regular font There was an example here that mentioned reload_plugins? but it was deleted. This commit puts another example back. --- guides/source/api_documentation_guidelines.textile | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/guides/source/api_documentation_guidelines.textile b/guides/source/api_documentation_guidelines.textile index 444490bf0c..c6aa1f0a2b 100644 --- a/guides/source/api_documentation_guidelines.textile +++ b/guides/source/api_documentation_guidelines.textile @@ -133,6 +133,20 @@ h4. Regular Font When "true" and "false" are English words rather than Ruby keywords use a regular font: + +# Runs all the validations within the specified context. Returns true if no errors are found, +# false otherwise. +# +# If the argument is false (default is +nil+), the context is set to :create if +# new_record? is true, and to :update if it is not. +# +# Validations with no :on option will run no matter the context. Validations with +# some :on option will only run in the specified context. +def valid?(context = nil) + ... +end + + h3. Description Lists In lists of options, parameters, etc. use a hyphen between the item and its description (reads better than a colon because normally options are symbols): -- cgit v1.2.3