From 5c3eda874fc7f874c193b64df7fdb38380819619 Mon Sep 17 00:00:00 2001
From: Zachary Scott <zachary@zacharyscott.net>
Date: Mon, 10 Feb 2014 23:29:33 -0800
Subject: 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
---
 guides/source/api_documentation_guidelines.md | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'guides')

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:
-- 
cgit v1.2.3