diff options
| author | Vijay Dev <vijaydev.cse@gmail.com> | 2014-02-20 22:28:37 +0530 |
|---|---|---|
| committer | Vijay Dev <vijaydev.cse@gmail.com> | 2014-02-20 22:28:37 +0530 |
| commit | b078f5ed843f23c61412ab21a94613377c9ad052 (patch) | |
| tree | dd1cb2e51307d0bd02d9f6207658ff83be722759 /guides | |
| parent | 17746181a31f18509687feeb03633ba8662c8036 (diff) | |
| parent | 5c3eda874fc7f874c193b64df7fdb38380819619 (diff) | |
| download | rails-b078f5ed843f23c61412ab21a94613377c9ad052.tar.gz rails-b078f5ed843f23c61412ab21a94613377c9ad052.tar.bz2 rails-b078f5ed843f23c61412ab21a94613377c9ad052.zip | |
Merge branch 'master' of github.com:rails/docrails
Diffstat (limited to 'guides')
| -rw-r--r-- | guides/source/api_documentation_guidelines.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md index 295c471db9..261538d0be 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/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: |