From 576f712380c5c02994ee14ff563c48d529b37881 Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Tue, 31 May 2011 22:56:31 +0200 Subject: standarize documentation (and indirectly code) to use American English as discussed in 4f234bf Please do not perform monster patches for this until 3.1 is out. Also, no existing API should be affected by this. New code, local variables, etc. would follow this guideline to have a consistent project tree in this regard. --- railties/guides/source/api_documentation_guidelines.textile | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'railties/guides/source/api_documentation_guidelines.textile') diff --git a/railties/guides/source/api_documentation_guidelines.textile b/railties/guides/source/api_documentation_guidelines.textile index e22ffa4c04..e046bc5cbb 100644 --- a/railties/guides/source/api_documentation_guidelines.textile +++ b/railties/guides/source/api_documentation_guidelines.textile @@ -33,6 +33,10 @@ Spell names correctly: Arel, Test::Unit, RSpec, HTML, MySQL, JavaScript, ERB. Wh Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database". +h3. English + +Please use American English (_color_, _center_, _modularize_, etc.). See "a list of American and British English spelling differences here":http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences. + h3. Example Code Choose meaningful examples that depict and cover the basics as well as interesting points or gotchas. -- cgit v1.2.3