diff options
| author | Xavier Noria <fxn@hashref.com> | 2011-06-06 22:23:30 +0200 |
|---|---|---|
| committer | Xavier Noria <fxn@hashref.com> | 2011-06-06 22:23:30 +0200 |
| commit | 5e21247131fa7d5484190c9a71b74f9d3f090684 (patch) | |
| tree | 5eee39fcabb952cafd513caf7e67943bc6b26e98 /railties/guides/source/api_documentation_guidelines.textile | |
| parent | 38ad6bb2f566202dd522a0cf31a55a746f122d53 (diff) | |
| parent | 689e12b828665b7b2cfcda85d46249c5cf2aa713 (diff) | |
| download | rails-5e21247131fa7d5484190c9a71b74f9d3f090684.tar.gz rails-5e21247131fa7d5484190c9a71b74f9d3f090684.tar.bz2 rails-5e21247131fa7d5484190c9a71b74f9d3f090684.zip | |
Merge branch 'master' of git://github.com/lifo/docrails
Conflicts:
activerecord/RUNNING_UNIT_TESTS
Diffstat (limited to 'railties/guides/source/api_documentation_guidelines.textile')
| -rw-r--r-- | railties/guides/source/api_documentation_guidelines.textile | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/railties/guides/source/api_documentation_guidelines.textile b/railties/guides/source/api_documentation_guidelines.textile index e046bc5cbb..50e86e05a8 100644 --- a/railties/guides/source/api_documentation_guidelines.textile +++ b/railties/guides/source/api_documentation_guidelines.textile @@ -41,8 +41,8 @@ h3. Example Code Choose meaningful examples that depict and cover the basics as well as interesting points or gotchas. -Use two spaces to indent chunks of code.—that is two spaces with respect to the left margin; the examples -themselves should use "Rails code conventions":http://rails.lighthouseapp.com/projects/8994/source-style. +Use two spaces to indent chunks of code--that is two spaces with respect to the left margin; the examples +themselves should use "Rails coding conventions":contributing_to_ruby_on_rails.html#follow-the-coding-conventions. Short docs do not need an explicit "Examples" label to introduce snippets, they just follow paragraphs: |