Permalink
Browse files

Merge branch 'master' of github.com:rails/docrails

  • Loading branch information...
2 parents 1774618 + 5c3eda8 commit b078f5ed843f23c61412ab21a94613377c9ad052 @vijaydev vijaydev committed Feb 20, 2014
Showing with 7 additions and 0 deletions.
  1. +7 −0 guides/source/api_documentation_guidelines.md
@@ -215,6 +215,13 @@ 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>`.
+You can quickly test the RDoc output with the following command:
+
+```
+$ echo "+:to_param+" | rdoc --pipe
+#=> <p><code>:to_param</code></p>
+```
+
### Regular Font
When "true" and "false" are English words rather than Ruby keywords use a regular font:

0 comments on commit b078f5e

Please sign in to comment.