[ruby/net-http] Remarks on inclusions

ruby/net-http@dfd060c583
ruby · Feb 2, 2023 · 3e5a77f · 3e5a77f
1 parent a874c3f
commit 3e5a77f
Show file tree

Hide file tree

Showing 4 changed files with 156 additions and 0 deletions.
diff --git a/doc/net-http/included_getters.rdoc b/doc/net-http/included_getters.rdoc
@@ -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].
diff --git a/doc/net-http/included_setters.rdoc b/doc/net-http/included_setters.rdoc
@@ -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].
diff --git a/lib/net/http/requests.rb b/lib/net/http/requests.rb
@@ -13,6 +13,8 @@
 #     http.request(req)
 #   end
 #
+# :include: doc/net-http/included_setters.rdoc
+#
 # Properties:
 #
 # - Request body: optional.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.