diff options
| author | Xavier Noria <fxn@hashref.com> | 2014-01-26 21:36:17 +0100 |
|---|---|---|
| committer | Xavier Noria <fxn@hashref.com> | 2014-01-26 21:36:17 +0100 |
| commit | 225bcadfed9f901d97867f9f9371c0e62379cb0f (patch) | |
| tree | fb01344895ccb9e46035f76031cb4560ba3bad73 /guides/source | |
| parent | 0df1f914104073b70f8d8976d0d5adc3b2a1e44e (diff) | |
| download | rails-225bcadfed9f901d97867f9f9371c0e62379cb0f.tar.gz rails-225bcadfed9f901d97867f9f9371c0e62379cb0f.tar.bz2 rails-225bcadfed9f901d97867f9f9371c0e62379cb0f.zip | |
API guidelines: revises warning about +...+ [ci skip]
Modern RDoc accepts a few more things in +...+. In particular symbols work now.
The current regexp in RDoc is https://github.com/rdoc/rdoc/blob/v4.1.1/lib/rdoc/markup/attribute_manager.rb#L133.
Diffstat (limited to 'guides/source')
| -rw-r--r-- | guides/source/api_documentation_guidelines.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md index 311cc23cf0..3f1243bc4d 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/guides/source/api_documentation_guidelines.md @@ -163,7 +163,10 @@ class Array end ``` -WARNING: Using a pair of `+...+` for fixed-width font only works with **words**; that is: anything matching `\A\w+\z`. For anything else use `<tt>...</tt>`, notably symbols, setters, inline snippets, etc. +WARNING: Using `+...+` for fixed-width font only works with simple content like +ordinary method names, symbols, paths (with forward slashes), etc. Please use +`<tt>...</tt>` for everything else, notably class or module names with a +namespace as in `<tt>ActiveRecord::Base</tt>`. ### Regular Font |