diff options
| author | Zachary Scott <zachary@zacharyscott.net> | 2014-02-10 23:29:33 -0800 |
|---|---|---|
| committer | Zachary Scott <zachary@zacharyscott.net> | 2014-02-10 23:29:33 -0800 |
| commit | 5c3eda874fc7f874c193b64df7fdb38380819619 (patch) | |
| tree | dc888f9c862d8534d8cdc50602868ed07305819d /guides/source/api_documentation_guidelines.md | |
| parent | 92fdd6516287f677cd6687e5c31298fa68931baa (diff) | |
| download | rails-5c3eda874fc7f874c193b64df7fdb38380819619.tar.gz rails-5c3eda874fc7f874c193b64df7fdb38380819619.tar.bz2 rails-5c3eda874fc7f874c193b64df7fdb38380819619.zip | |
Add tip about using RDoc's --pipe command to quickly test the output of
a piece of documentation.
This can be useful for trying out combinations of markup and code, as
discussed in rails/rails@225bcad
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
| -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: |