Browse files

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
  • Loading branch information...
zzak committed Feb 11, 2014
1 parent 92fdd65 commit 5c3eda874fc7f874c193b64df7fdb38380819619
Showing with 7 additions and 0 deletions.
  1. +7 −0 guides/source/
@@ -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 5c3eda8

Please sign in to comment.