Skip to content
Browse files

restores the example for fixed-width font in API guidelines

  • Loading branch information...
1 parent 7a2be37 commit c577e90f61b060164589e7112838e461c42bfe29 @fxn fxn committed Nov 10, 2010
Showing with 10 additions and 0 deletions.
  1. +10 −0 railties/guides/source/api_documentation_guidelines.textile
View
10 railties/guides/source/api_documentation_guidelines.textile
@@ -115,6 +115,16 @@ Use fixed-width fonts for:
* method parameters
* file names
+<ruby>
+class Array
+ # Calls <tt>to_param</tt> on all its elements and joins the result with
+ # slashes. This is used by <tt>url_for</tt> in Action Pack.
+ def to_param
+ collect { |e| e.to_param }.join '/'
+ end
+end
+</ruby>
+
WARNING: Using a pair of +&#43;...&#43;+ for fixed-width font only works with *words*; that is: anything matching <tt>\A\w&#43;\z</tt>. For anything else use +&lt;tt&gt;...&lt;/tt&gt;+, notably symbols, setters, inline snippets, etc:
h4. Regular Font

0 comments on commit c577e90

Please sign in to comment.
Something went wrong with that request. Please try again.