/
api_documentation_guidelines.html
473 lines (443 loc) · 27.5 KB
/
api_documentation_guidelines.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>API Documentation Guidelines — Ruby on Rails Guides</title>
<link rel="stylesheet" type="text/css" href="stylesheets/style.css" data-turbolinks-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shCore.css" data-turbolinks-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shThemeRailsGuides.css" data-turbolinks-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/fixes.css" data-turbolinks-track="reload">
<link href="images/favicon.ico" rel="shortcut icon" type="image/x-icon" />
<script src="javascripts/syntaxhighlighter.js" data-turbolinks-track="reload"></script>
<script src="javascripts/turbolinks.js" data-turbolinks-track="reload"></script>
<script src="javascripts/guides.js" data-turbolinks-track="reload"></script>
<script src="javascripts/responsive-tables.js" data-turbolinks-track="reload"></script>
</head>
<body class="guide">
<div>
<img src="images/edge_badge.png" alt="edge-badge" id="edge-badge" />
</div>
<div id="topNav">
<div class="wrapper">
<strong class="more-info-label">Veja mais em <a href="http://rubyonrails.org/">rubyonrails.org:</a> </strong>
<span class="red-button more-info-button">
Mais Ruby on Rails
</span>
<ul class="more-info-links s-hidden">
<li class="more-info"><a href="https://weblog.rubyonrails.org/">Blog</a></li>
<li class="more-info"><a href="https://guides.rubyonrails.org/">Guia</a></li>
<li class="more-info"><a href="http://api.rubyonrails.org/">API</a></li>
<li class="more-info"><a href="https://stackoverflow.com/questions/tagged/ruby-on-rails">Pedir ajuda</a></li>
<li class="more-info"><a href="https://github.com/rails/rails">Contribuir no GitHub</a></li>
</ul>
</div>
</div>
<div id="header">
<div class="wrapper clearfix">
<h1><a href="index.html" title="Return to home page">Guides.rubyonrails.org</a></h1>
<ul class="nav">
<li><a class="nav-item" href="index.html">Home</a></li>
<li class="guides-index guides-index-large">
<a href="index.html" id="guidesMenu" class="guides-index-item nav-item">Guias</a>
<div id="guides" class="clearfix" style="display: none;">
<hr />
<div class="guides-section-container">
<div class="guides-section">
<dt>Comece Aqui</dt>
</div>
<div class="guides-section">
<dt>Models</dt>
</div>
<div class="guides-section">
<dt>Views</dt>
</div>
<div class="guides-section">
<dt>Controllers</dt>
</div>
<div class="guides-section">
<dt>Other Components</dt>
</div>
<div class="guides-section">
<dt>Digging Deeper</dt>
</div>
<div class="guides-section">
<dt>Extending Rails</dt>
<dd><a href="rails_on_rack.html">Rails on Rack</a></dd>
<dd><a href="generators.html">Creating and Customizing Rails Generators & Templates</a></dd>
</div>
<div class="guides-section">
<dt>Contributions</dt>
<dd><a href="contributing_to_ruby_on_rails.html">Contributing to Ruby on Rails</a></dd>
<dd><a href="api_documentation_guidelines.html">API Documentation Guidelines</a></dd>
<dd><a href="ruby_on_rails_guides_guidelines.html">Guides Guidelines</a></dd>
</div>
<div class="guides-section">
<dt>Policies</dt>
<dd><a href="maintenance_policy.html">Maintenance Policy</a></dd>
</div>
<div class="guides-section">
<dt>Release Notes</dt>
<dd><a href="upgrading_ruby_on_rails.html">Upgrading Ruby on Rails</a></dd>
<dd><a href="5_2_release_notes.html">Version 5.2 - April 2018</a></dd>
<dd><a href="5_1_release_notes.html">Version 5.1 - April 2017</a></dd>
<dd><a href="5_0_release_notes.html">Version 5.0 - June 2016</a></dd>
<dd><a href="4_2_release_notes.html">Version 4.2 - December 2014</a></dd>
<dd><a href="4_1_release_notes.html">Version 4.1 - April 2014</a></dd>
<dd><a href="4_0_release_notes.html">Version 4.0 - June 2013</a></dd>
<dd><a href="3_2_release_notes.html">Version 3.2 - January 2012</a></dd>
<dd><a href="3_1_release_notes.html">Version 3.1 - August 2011</a></dd>
<dd><a href="3_0_release_notes.html">Version 3.0 - August 2010</a></dd>
<dd><a href="2_3_release_notes.html">Version 2.3 - March 2009</a></dd>
<dd><a href="2_2_release_notes.html">Version 2.2 - November 2008</a></dd>
</div>
</div>
</div>
</li>
<li><a class="nav-item" href="contributing_to_ruby_on_rails.html">Contribua</a></li>
<li class="guides-index guides-index-small">
<select class="guides-index-item nav-item">
<option value="index.html">Guias</option>
<optgroup label="Comece Aqui">
</optgroup>
<optgroup label="Models">
</optgroup>
<optgroup label="Views">
</optgroup>
<optgroup label="Controllers">
</optgroup>
<optgroup label="Other Components">
</optgroup>
<optgroup label="Digging Deeper">
</optgroup>
<optgroup label="Extending Rails">
<option value="rails_on_rack.html">Rails on Rack</option>
<option value="generators.html">Creating and Customizing Rails Generators & Templates</option>
</optgroup>
<optgroup label="Contributions">
<option value="contributing_to_ruby_on_rails.html">Contributing to Ruby on Rails</option>
<option value="api_documentation_guidelines.html">API Documentation Guidelines</option>
<option value="ruby_on_rails_guides_guidelines.html">Guides Guidelines</option>
</optgroup>
<optgroup label="Policies">
<option value="maintenance_policy.html">Maintenance Policy</option>
</optgroup>
<optgroup label="Release Notes">
<option value="upgrading_ruby_on_rails.html">Upgrading Ruby on Rails</option>
<option value="5_2_release_notes.html">Version 5.2 - April 2018</option>
<option value="5_1_release_notes.html">Version 5.1 - April 2017</option>
<option value="5_0_release_notes.html">Version 5.0 - June 2016</option>
<option value="4_2_release_notes.html">Version 4.2 - December 2014</option>
<option value="4_1_release_notes.html">Version 4.1 - April 2014</option>
<option value="4_0_release_notes.html">Version 4.0 - June 2013</option>
<option value="3_2_release_notes.html">Version 3.2 - January 2012</option>
<option value="3_1_release_notes.html">Version 3.1 - August 2011</option>
<option value="3_0_release_notes.html">Version 3.0 - August 2010</option>
<option value="2_3_release_notes.html">Version 2.3 - March 2009</option>
<option value="2_2_release_notes.html">Version 2.2 - November 2008</option>
</optgroup>
</select>
</li>
</ul>
</div>
</div>
<hr class="hide" />
<div id="feature">
<div class="wrapper">
<h2>API Documentation Guidelines</h2><p>This guide documents the Ruby on Rails API documentation guidelines.</p><p>After reading this guide, you will know:</p>
<ul>
<li>How to write effective prose for documentation purposes.</li>
<li>Style guidelines for documenting different kinds of Ruby code.</li>
</ul>
<div id="subCol">
<h3 class="chapter"><img src="images/chapters_icon.gif" alt="" />Chapters</h3>
<ol class="chapters">
<li><a href="#rdoc">RDoc</a></li>
<li><a href="#wording">Wording</a></li>
<li><a href="#english">English</a></li>
<li><a href="#oxford-comma">Oxford Comma</a></li>
<li><a href="#example-code">Example Code</a></li>
<li><a href="#booleans">Booleans</a></li>
<li><a href="#file-names">File Names</a></li>
<li>
<a href="#fonts">Fonts</a>
<ul>
<li><a href="#fixed-width-font">Fixed-width Font</a></li>
<li><a href="#regular-font">Regular Font</a></li>
</ul>
</li>
<li><a href="#description-lists">Description Lists</a></li>
<li><a href="#dynamically-generated-methods">Dynamically Generated Methods</a></li>
<li><a href="#method-visibility">Method Visibility</a></li>
<li><a href="#regarding-the-rails-stack">Regarding the Rails Stack</a></li>
</ol>
</div>
</div>
</div>
<div id="container">
<div class="wrapper">
<div id="mainCol">
<h3 id="rdoc"><a class="anchorlink" href="#rdoc">1 RDoc</a></h3><p>The <a href="http://edgeapi.rubyonrails.org">Rails API documentation</a> is generated with
<a href="https://ruby.github.io/rdoc/">RDoc</a>. To generate it, make sure you are
in the rails root directory, run <code>bundle install</code> and execute:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
bundle exec rake rdoc
</pre>
</div>
<p>Resulting HTML files can be found in the ./doc/rdoc directory.</p><p>Please consult the RDoc documentation for help with the
<a href="https://ruby.github.io/rdoc/RDoc/Markup.html">markup</a>,
and also take into account these <a href="https://ruby.github.io/rdoc/RDoc/Parser/Ruby.html">additional
directives</a>.</p><h3 id="wording"><a class="anchorlink" href="#wording">2 Wording</a></h3><p>Write simple, declarative sentences. Brevity is a plus: get to the point.</p><p>Write in present tense: "Returns a hash that...", rather than "Returned a hash that..." or "Will return a hash that...".</p><p>Start comments in upper case. Follow regular punctuation rules:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# Declares an attribute reader backed by an internally-named
# instance variable.
def attr_internal_reader(*attrs)
...
end
</pre>
</div>
<p>Communicate to the reader the current way of doing things, both explicitly and implicitly. Use the idioms recommended in edge. Reorder sections to emphasize favored approaches if needed, etc. The documentation should be a model for best practices and canonical, modern Rails usage.</p><p>Documentation has to be concise but comprehensive. Explore and document edge cases. What happens if a module is anonymous? What if a collection is empty? What if an argument is nil?</p><p>The proper names of Rails components have a space in between the words, like "Active Support". <code>ActiveRecord</code> is a Ruby module, whereas Active Record is an ORM. All Rails documentation should consistently refer to Rails components by their proper name, and if in your next blog post or presentation you remember this tidbit and take it into account that'd be phenomenal.</p><p>Spell names correctly: Arel, minitest, RSpec, HTML, MySQL, JavaScript, ERB. When in doubt, please have a look at some authoritative source like their official documentation.</p><p>Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database".</p><p>Prefer wordings that avoid "you"s and "your"s. For example, instead of</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
If you need to use `return` statements in your callbacks, it is recommended that you explicitly define them as methods.
</pre>
</div>
<p>use this style:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
If `return` is needed it is recommended to explicitly define a method.
</pre>
</div>
<p>That said, when using pronouns in reference to a hypothetical person, such as "a
user with a session cookie", gender neutral pronouns (they/their/them) should be
used. Instead of:</p>
<ul>
<li>he or she... use they.</li>
<li>him or her... use them.</li>
<li>his or her... use their.</li>
<li>his or hers... use theirs.</li>
<li>himself or herself... use themselves.</li>
</ul>
<h3 id="english"><a class="anchorlink" href="#english">3 English</a></h3><p>Please use American English (<em>color</em>, <em>center</em>, <em>modularize</em>, etc). See <a href="https://en.wikipedia.org/wiki/American_and_British_English_spelling_differences">a list of American and British English spelling differences here</a>.</p><h3 id="oxford-comma"><a class="anchorlink" href="#oxford-comma">4 Oxford Comma</a></h3><p>Please use the <a href="https://en.wikipedia.org/wiki/Serial_comma">Oxford comma</a>
("red, white, and blue", instead of "red, white and blue").</p><h3 id="example-code"><a class="anchorlink" href="#example-code">5 Example Code</a></h3><p>Choose meaningful examples that depict and cover the basics as well as interesting points or gotchas.</p><p>Use two spaces to indent chunks of code--that is, for markup purposes, two spaces with respect to the left margin. The examples themselves should use <a href="contributing_to_ruby_on_rails.html#follow-the-coding-conventions">Rails coding conventions</a>.</p><p>Short docs do not need an explicit "Examples" label to introduce snippets; they just follow paragraphs:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# Converts a collection of elements into a formatted string by
# calling +to_s+ on all elements and joining them.
#
# Blog.all.to_formatted_s # => "First PostSecond PostThird Post"
</pre>
</div>
<p>On the other hand, big chunks of structured documentation may have a separate "Examples" section:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# ==== Examples
#
# Person.exists?(5)
# Person.exists?('5')
# Person.exists?(name: "David")
# Person.exists?(['name LIKE ?', "%#{query}%"])
</pre>
</div>
<p>The results of expressions follow them and are introduced by "# => ", vertically aligned:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# For checking if an integer is even or odd.
#
# 1.even? # => false
# 1.odd? # => true
# 2.even? # => true
# 2.odd? # => false
</pre>
</div>
<p>If a line is too long, the comment may be placed on the next line:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# label(:article, :title)
# # => <label for="article_title">Title</label>
#
# label(:article, :title, "A short title")
# # => <label for="article_title">A short title</label>
#
# label(:article, :title, "A short title", class: "title_label")
# # => <label for="article_title" class="title_label">A short title</label>
</pre>
</div>
<p>Avoid using any printing methods like <code>puts</code> or <code>p</code> for that purpose.</p><p>On the other hand, regular comments do not use an arrow:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# polymorphic_url(record) # same as comment_url(record)
</pre>
</div>
<h3 id="booleans"><a class="anchorlink" href="#booleans">6 Booleans</a></h3><p>In predicates and flags prefer documenting boolean semantics over exact values.</p><p>When "true" or "false" are used as defined in Ruby use regular font. The
singletons <code>true</code> and <code>false</code> need fixed-width font. Please avoid terms like
"truthy", Ruby defines what is true and false in the language, and thus those
words have a technical meaning and need no substitutes.</p><p>As a rule of thumb, do not document singletons unless absolutely necessary. That
prevents artificial constructs like <code>!!</code> or ternaries, allows refactors, and the
code does not need to rely on the exact values returned by methods being called
in the implementation.</p><p>For example:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
`config.action_mailer.perform_deliveries` specifies whether mail will actually be delivered and is true by default
</pre>
</div>
<p>the user does not need to know which is the actual default value of the flag,
and so we only document its boolean semantics.</p><p>An example with a predicate:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# Returns true if the collection is empty.
#
# If the collection has been loaded
# it is equivalent to <tt>collection.size.zero?</tt>. If the
# collection has not been loaded, it is equivalent to
# <tt>collection.exists?</tt>. If the collection has not already been
# loaded and you are going to fetch the records anyway it is better to
# check <tt>collection.length.zero?</tt>.
def empty?
if loaded?
size.zero?
else
@target.blank? && !scope.exists?
end
end
</pre>
</div>
<p>The API is careful not to commit to any particular value, the method has
predicate semantics, that's enough.</p><h3 id="file-names"><a class="anchorlink" href="#file-names">7 File Names</a></h3><p>As a rule of thumb, use filenames relative to the application root:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
config/routes.rb # YES
routes.rb # NO
RAILS_ROOT/config/routes.rb # NO
</pre>
</div>
<h3 id="fonts"><a class="anchorlink" href="#fonts">8 Fonts</a></h3><h4 id="fixed-width-font"><a class="anchorlink" href="#fixed-width-font">8.1 Fixed-width Font</a></h4><p>Use fixed-width fonts for:</p>
<ul>
<li>Constants, in particular class and module names.</li>
<li>Method names.</li>
<li>Literals like <code>nil</code>, <code>false</code>, <code>true</code>, <code>self</code>.</li>
<li>Symbols.</li>
<li>Method parameters.</li>
<li>File names.</li>
</ul>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Array
# Calls +to_param+ on all its elements and joins the result with
# slashes. This is used by +url_for+ in Action Pack.
def to_param
collect { |e| e.to_param }.join '/'
end
end
</pre>
</div>
<div class="warning"><p>Using <code>+...+</code> for fixed-width font only works with simple content like
ordinary method names, symbols, paths (with forward slashes), etc. Please use
<code><tt>...</tt></code> for everything else, notably class or module names with a
namespace as in <code><tt>ActiveRecord::Base</tt></code>.</p></div><p>You can quickly test the RDoc output with the following command:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ echo "+:to_param+" | rdoc --pipe
# => <p><code>:to_param</code></p>
</pre>
</div>
<h4 id="regular-font"><a class="anchorlink" href="#regular-font">8.2 Regular Font</a></h4><p>When "true" and "false" are English words rather than Ruby keywords use a regular font:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# Runs all the validations within the specified context.
# Returns true if no errors are found, false otherwise.
#
# If the argument is false (default is +nil+), the context is
# set to <tt>:create</tt> if <tt>new_record?</tt> is true,
# and to <tt>:update</tt> if it is not.
#
# Validations with no <tt>:on</tt> option will run no
# matter the context. Validations with # some <tt>:on</tt>
# option will only run in the specified context.
def valid?(context = nil)
...
end
</pre>
</div>
<h3 id="description-lists"><a class="anchorlink" href="#description-lists">9 Description Lists</a></h3><p>In lists of options, parameters, etc. use a hyphen between the item and its description (reads better than a colon because normally options are symbols):</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+.
</pre>
</div>
<p>The description starts in upper case and ends with a full stop-it's standard English.</p><h3 id="dynamically-generated-methods"><a class="anchorlink" href="#dynamically-generated-methods">10 Dynamically Generated Methods</a></h3><p>Methods created with <code>(module|class)_eval(STRING)</code> have a comment by their side with an instance of the generated code. That comment is 2 spaces away from the template:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
for severity in Severity.constants
class_eval <<-EOT, __FILE__, __LINE__ + 1
def #{severity.downcase}(message = nil, progname = nil, &block) # def debug(message = nil, progname = nil, &block)
add(#{severity}, message, progname, &block) # add(DEBUG, message, progname, &block)
end # end
#
def #{severity.downcase}? # def debug?
#{severity} >= @level # DEBUG >= @level
end # end
EOT
end
</pre>
</div>
<p>If the resulting lines are too wide, say 200 columns or more, put the comment above the call:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# def self.find_by_login_and_activated(*args)
# options = args.extract_options!
# ...
# end
self.class_eval %{
def self.#{method_id}(*args)
options = args.extract_options!
...
end
}
</pre>
</div>
<h3 id="method-visibility"><a class="anchorlink" href="#method-visibility">11 Method Visibility</a></h3><p>When writing documentation for Rails, it's important to understand the difference between public user-facing API vs internal API.</p><p>Rails, like most libraries, uses the private keyword from Ruby for defining internal API. However, public API follows a slightly different convention. Instead of assuming all public methods are designed for user consumption, Rails uses the <code>:nodoc:</code> directive to annotate these kinds of methods as internal API.</p><p>This means that there are methods in Rails with <code>public</code> visibility that aren't meant for user consumption.</p><p>An example of this is <code>ActiveRecord::Core::ClassMethods#arel_table</code>:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
module ActiveRecord::Core::ClassMethods
def arel_table #:nodoc:
# do some magic..
end
end
</pre>
</div>
<p>If you thought, "this method looks like a public class method for <code>ActiveRecord::Core</code>", you were right. But actually the Rails team doesn't want users to rely on this method. So they mark it as <code>:nodoc:</code> and it's removed from public documentation. The reasoning behind this is to allow the team to change these methods according to their internal needs across releases as they see fit. The name of this method could change, or the return value, or this entire class may disappear; there's no guarantee and so you shouldn't depend on this API in your plugins or applications. Otherwise, you risk your app or gem breaking when you upgrade to a newer release of Rails.</p><p>As a contributor, it's important to think about whether this API is meant for end-user consumption. The Rails team is committed to not making any breaking changes to public API across releases without going through a full deprecation cycle. It's recommended that you <code>:nodoc:</code> any of your internal methods/classes unless they're already private (meaning visibility), in which case it's internal by default. Once the API stabilizes the visibility can change, but changing public API is much harder due to backwards compatibility.</p><p>A class or module is marked with <code>:nodoc:</code> to indicate that all methods are internal API and should never be used directly.</p><p>To summarize, the Rails team uses <code>:nodoc:</code> to mark publicly visible methods and classes for internal use; changes to the visibility of API should be considered carefully and discussed over a pull request first.</p><h3 id="regarding-the-rails-stack"><a class="anchorlink" href="#regarding-the-rails-stack">12 Regarding the Rails Stack</a></h3><p>When documenting parts of Rails API, it's important to remember all of the
pieces that go into the Rails stack.</p><p>This means that behavior may change depending on the scope or context of the
method or class you're trying to document.</p><p>In various places there is different behavior when you take the entire stack
into account, one such example is
<code>ActionView::Helpers::AssetTagHelper#image_tag</code>:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# image_tag("icon.png")
# # => <img src="/assets/icon.png" />
</pre>
</div>
<p>Although the default behavior for <code>#image_tag</code> is to always return
<code>/images/icon.png</code>, we take into account the full Rails stack (including the
Asset Pipeline) we may see the result seen above.</p><p>We're only concerned with the behavior experienced when using the full default
Rails stack.</p><p>In this case, we want to document the behavior of the <em>framework</em>, and not just
this specific method.</p><p>If you have a question on how the Rails team handles certain API, don't hesitate to open a ticket or send a patch to the <a href="https://github.com/rails/rails/issues">issue tracker</a>.</p>
<h3>Feedback</h3>
<p>
You're encouraged to help improve the quality of this guide.
</p>
<p>
Please contribute if you see any typos or factual errors.
To get started, you can read our <a href="https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#contributing-to-the-rails-documentation">documentation contributions</a> section.
</p>
<p>
You may also find incomplete content or stuff that is not up to date.
Please do add any missing documentation for master. Make sure to check
<a href="https://edgeguides.rubyonrails.org">Edge Guides</a> first to verify
if the issues are already fixed or not on the master branch.
Check the <a href="ruby_on_rails_guides_guidelines.html">Ruby on Rails Guides Guidelines</a>
for style and conventions.
</p>
<p>
If for whatever reason you spot something to fix but cannot patch it yourself, please
<a href="https://github.com/rails/rails/issues">open an issue</a>.
</p>
<p>And last but not least, any kind of discussion regarding Ruby on Rails
documentation is very welcome on the <a href="https://groups.google.com/forum/#!forum/rubyonrails-docs">rubyonrails-docs mailing list</a>.
</p>
</div>
</div>
</div>
<hr class="hide" />
<div id="footer">
<div class="wrapper">
<p>This work is licensed under a <a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International</a> License</p>
<p>"Rails", "Ruby on Rails", and the Rails logo are trademarks of David Heinemeier Hansson. All rights reserved.</p>
</div>
</div>
</body>
</html>