Skip to content

Commit b4436ba

Browse files
authored
Merge pull request #114 from BurdetteLamar/inclusions
[DOC] Remarks on inclusions
2 parents 14c8405 + dfd060c commit b4436ba

File tree

4 files changed

+156
-0
lines changed

4 files changed

+156
-0
lines changed

doc/net-http/included_getters.rdoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This class also includes (indirectly) module Net::HTTPHeader,
2+
which gives access to its
3+
{methods for getting headers}[rdoc-ref:Net::HTTPHeader@Getters].

doc/net-http/included_setters.rdoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This class also includes (indirectly) module Net::HTTPHeader,
2+
which gives access to its
3+
{methods for setting headers}[rdoc-ref:Net::HTTPHeader@Setters].

lib/net/http/requests.rb

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
# http.request(req)
1414
# end
1515
#
16+
# :include: doc/net-http/included_setters.rdoc
17+
#
1618
# Properties:
1719
#
1820
# - Request body: optional.
@@ -43,6 +45,8 @@ class Net::HTTP::Get < Net::HTTPRequest
4345
# http.request(req)
4446
# end
4547
#
48+
# :include: doc/net-http/included_setters.rdoc
49+
#
4650
# Properties:
4751
#
4852
# - Request body: optional.
@@ -75,6 +79,8 @@ class Net::HTTP::Head < Net::HTTPRequest
7579
# http.request(req)
7680
# end
7781
#
82+
# :include: doc/net-http/included_setters.rdoc
83+
#
7884
# Properties:
7985
#
8086
# - Request body: yes.
@@ -108,6 +114,8 @@ class Net::HTTP::Post < Net::HTTPRequest
108114
# http.request(req)
109115
# end
110116
#
117+
# :include: doc/net-http/included_setters.rdoc
118+
#
111119
# Properties:
112120
#
113121
# - Request body: yes.
@@ -134,6 +142,8 @@ class Net::HTTP::Put < Net::HTTPRequest
134142
# http.request(req)
135143
# end
136144
#
145+
# :include: doc/net-http/included_setters.rdoc
146+
#
137147
# Properties:
138148
#
139149
# - Request body: optional.
@@ -163,6 +173,8 @@ class Net::HTTP::Delete < Net::HTTPRequest
163173
# http.request(req)
164174
# end
165175
#
176+
# :include: doc/net-http/included_setters.rdoc
177+
#
166178
# Properties:
167179
#
168180
# - Request body: optional.
@@ -192,6 +204,8 @@ class Net::HTTP::Options < Net::HTTPRequest
192204
# http.request(req)
193205
# end
194206
#
207+
# :include: doc/net-http/included_setters.rdoc
208+
#
195209
# Properties:
196210
#
197211
# - Request body: no.
@@ -224,6 +238,8 @@ class Net::HTTP::Trace < Net::HTTPRequest
224238
# http.request(req)
225239
# end
226240
#
241+
# :include: doc/net-http/included_setters.rdoc
242+
#
227243
# Properties:
228244
#
229245
# - Request body: yes.
@@ -257,6 +273,8 @@ class Net::HTTP::Patch < Net::HTTPRequest
257273
# http.request(req)
258274
# end
259275
#
276+
# :include: doc/net-http/included_setters.rdoc
277+
#
260278
# Related:
261279
#
262280
# - Net::HTTP#propfind: sends +PROPFIND+ request, returns response object.
@@ -278,6 +296,8 @@ class Net::HTTP::Propfind < Net::HTTPRequest
278296
# http.request(req)
279297
# end
280298
#
299+
# :include: doc/net-http/included_setters.rdoc
300+
#
281301
# Related:
282302
#
283303
# - Net::HTTP#proppatch: sends +PROPPATCH+ request, returns response object.
@@ -299,6 +319,8 @@ class Net::HTTP::Proppatch < Net::HTTPRequest
299319
# http.request(req)
300320
# end
301321
#
322+
# :include: doc/net-http/included_setters.rdoc
323+
#
302324
# Related:
303325
#
304326
# - Net::HTTP#mkcol: sends +MKCOL+ request, returns response object.
@@ -320,6 +342,8 @@ class Net::HTTP::Mkcol < Net::HTTPRequest
320342
# http.request(req)
321343
# end
322344
#
345+
# :include: doc/net-http/included_setters.rdoc
346+
#
323347
# Related:
324348
#
325349
# - Net::HTTP#copy: sends +COPY+ request, returns response object.
@@ -341,6 +365,8 @@ class Net::HTTP::Copy < Net::HTTPRequest
341365
# http.request(req)
342366
# end
343367
#
368+
# :include: doc/net-http/included_setters.rdoc
369+
#
344370
# Related:
345371
#
346372
# - Net::HTTP#move: sends +MOVE+ request, returns response object.
@@ -362,6 +388,8 @@ class Net::HTTP::Move < Net::HTTPRequest
362388
# http.request(req)
363389
# end
364390
#
391+
# :include: doc/net-http/included_setters.rdoc
392+
#
365393
# Related:
366394
#
367395
# - Net::HTTP#lock: sends +LOCK+ request, returns response object.
@@ -383,6 +411,8 @@ class Net::HTTP::Lock < Net::HTTPRequest
383411
# http.request(req)
384412
# end
385413
#
414+
# :include: doc/net-http/included_setters.rdoc
415+
#
386416
# Related:
387417
#
388418
# - Net::HTTP#unlock: sends +UNLOCK+ request, returns response object.

0 commit comments

Comments
 (0)