Skip to content

[DOC] Remarks on inclusions #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 2, 2023
+156 −0
Merged

[DOC] Remarks on inclusions #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/net-http/included_getters.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This class also includes (indirectly) module Net::HTTPHeader,
which gives access to its
{methods for getting headers}[rdoc-ref:Net::HTTPHeader@Getters].
3 changes: 3 additions & 0 deletions doc/net-http/included_setters.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This class also includes (indirectly) module Net::HTTPHeader,
which gives access to its
{methods for setting headers}[rdoc-ref:Net::HTTPHeader@Setters].
30 changes: 30 additions & 0 deletions lib/net/http/requests.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Properties:
#
# - Request body: optional.
Expand Down Expand Up @@ -43,6 +45,8 @@ class Net::HTTP::Get < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Properties:
#
# - Request body: optional.
Expand Down Expand Up @@ -75,6 +79,8 @@ class Net::HTTP::Head < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Properties:
#
# - Request body: yes.
Expand Down Expand Up @@ -108,6 +114,8 @@ class Net::HTTP::Post < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Properties:
#
# - Request body: yes.
Expand All @@ -134,6 +142,8 @@ class Net::HTTP::Put < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Properties:
#
# - Request body: optional.
Expand Down Expand Up @@ -163,6 +173,8 @@ class Net::HTTP::Delete < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Properties:
#
# - Request body: optional.
Expand Down Expand Up @@ -192,6 +204,8 @@ class Net::HTTP::Options < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Properties:
#
# - Request body: no.
Expand Down Expand Up @@ -224,6 +238,8 @@ class Net::HTTP::Trace < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Properties:
#
# - Request body: yes.
Expand Down Expand Up @@ -257,6 +273,8 @@ class Net::HTTP::Patch < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Related:
#
# - Net::HTTP#propfind: sends +PROPFIND+ request, returns response object.
Expand All @@ -278,6 +296,8 @@ class Net::HTTP::Propfind < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Related:
#
# - Net::HTTP#proppatch: sends +PROPPATCH+ request, returns response object.
Expand All @@ -299,6 +319,8 @@ class Net::HTTP::Proppatch < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Related:
#
# - Net::HTTP#mkcol: sends +MKCOL+ request, returns response object.
Expand All @@ -320,6 +342,8 @@ class Net::HTTP::Mkcol < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Related:
#
# - Net::HTTP#copy: sends +COPY+ request, returns response object.
Expand All @@ -341,6 +365,8 @@ class Net::HTTP::Copy < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Related:
#
# - Net::HTTP#move: sends +MOVE+ request, returns response object.
Expand All @@ -362,6 +388,8 @@ class Net::HTTP::Move < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Related:
#
# - Net::HTTP#lock: sends +LOCK+ request, returns response object.
Expand All @@ -383,6 +411,8 @@ class Net::HTTP::Lock < Net::HTTPRequest
# http.request(req)
# end
#
# :include: doc/net-http/included_setters.rdoc
#
# Related:
#
# - Net::HTTP#unlock: sends +UNLOCK+ request, returns response object.
Expand Down
Loading