kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Add tip about using RDoc's --pipe command to quickly test the output of

Browse source 
a piece of documentation.

This can be useful for trying out combinations of markup and code, as
discussed in rails/rails@225bcad
This commit is contained in:
Zachary Scott 2014-02-10 23:29:33 -08:00
parent 92fdd65162
commit 5c3eda874f
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
guides/source/api_documentation_guidelines.md
View file

@ -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: