From 58e13db82d40e1b3bae3892277a86de5c8408b5f Mon Sep 17 00:00:00 2001 From: 0x1eef <0x1eef@protonmail.com> Date: Wed, 20 Nov 2024 21:56:23 -0300 Subject: [PATCH] Silence doc warnings during 'gem install net-http' Fix #193 Reproduction steps: gem build net-http.gemspec mv net-http-0.5.0.gem ${HOME} cd ${HOME} gem install net-http-0.5.0.gem --- lib/net/http.rb | 2 +- lib/net/http/generic_request.rb | 2 +- lib/net/http/header.rb | 2 +- lib/net/http/response.rb | 2 +- lib/net/http/responses.rb | 120 ++++++++++++++++---------------- 5 files changed, 64 insertions(+), 64 deletions(-) diff --git a/lib/net/http.rb b/lib/net/http.rb index 7a5b080c..e368c04e 100644 --- a/lib/net/http.rb +++ b/lib/net/http.rb @@ -41,7 +41,7 @@ class HTTPHeaderSyntaxError < StandardError; end # # == About the Examples # - # :include: doc/net-http/examples.rdoc + # :include: ../../doc/net-http/examples.rdoc # # == Strategies # diff --git a/lib/net/http/generic_request.rb b/lib/net/http/generic_request.rb index 44e329a0..22cd9b43 100644 --- a/lib/net/http/generic_request.rb +++ b/lib/net/http/generic_request.rb @@ -6,7 +6,7 @@ # # == About the Examples # -# :include: doc/net-http/examples.rdoc +# :include: ../../../doc/net-http/examples.rdoc # class Net::HTTPGenericRequest diff --git a/lib/net/http/header.rb b/lib/net/http/header.rb index 30c632cc..354171e3 100644 --- a/lib/net/http/header.rb +++ b/lib/net/http/header.rb @@ -31,7 +31,7 @@ # # == About the Examples # -# :include: doc/net-http/examples.rdoc +# :include: ../../../doc/net-http/examples.rdoc # # == Fields # diff --git a/lib/net/http/response.rb b/lib/net/http/response.rb index 3aeba2e5..a4b524e1 100644 --- a/lib/net/http/response.rb +++ b/lib/net/http/response.rb @@ -4,7 +4,7 @@ # # == About the Examples # -# :include: doc/net-http/examples.rdoc +# :include: ../../../doc/net-http/examples.rdoc # # == Returned Responses # diff --git a/lib/net/http/responses.rb b/lib/net/http/responses.rb index 6f6fb8d0..7e7bd8d3 100644 --- a/lib/net/http/responses.rb +++ b/lib/net/http/responses.rb @@ -85,7 +85,7 @@ class HTTPServerError < HTTPResponse # # A +Continue+ response indicates that the server has received the request headers. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -102,7 +102,7 @@ class HTTPContinue < HTTPInformation # The Switching Protocol response indicates that the server has received # a request to switch protocols, and has agreed to do so. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -119,7 +119,7 @@ class HTTPSwitchProtocol < HTTPInformation # The +Processing+ response indicates that the server has received # and is processing the request, but no response is available yet. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -136,7 +136,7 @@ class HTTPProcessing < HTTPInformation # and is processing the request, and contains certain headers; # the final response is not available yet. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -153,7 +153,7 @@ class HTTPEarlyHints < HTTPInformation # The +OK+ response indicates that the server has received # a request and has responded successfully. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -170,7 +170,7 @@ class HTTPOK < HTTPSuccess # The +Created+ response indicates that the server has received # and has fulfilled a request to create a new resource. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -187,7 +187,7 @@ class HTTPCreated < HTTPSuccess # The +Accepted+ response indicates that the server has received # and is processing a request, but the processing has not yet been completed. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -206,7 +206,7 @@ class HTTPAccepted < HTTPSuccess # that received a 200 OK response from its origin, # and is returning a modified version of the origin's response. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -223,7 +223,7 @@ class HTTPNonAuthoritativeInformation < HTTPSuccess # The No Content response indicates that the server # successfully processed the request, and is not returning any content. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -241,7 +241,7 @@ class HTTPNoContent < HTTPSuccess # successfully processed the request, # asks that the client reset its document view, and is not returning any content. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -259,7 +259,7 @@ class HTTPResetContent < HTTPSuccess # only part of the resource (byte serving) # due to a Range header in the request. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -277,7 +277,7 @@ class HTTPPartialContent < HTTPSuccess # has received the request, # and that the message body can contain a number of separate response codes. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -296,7 +296,7 @@ class HTTPMultiStatus < HTTPSuccess # in a preceding part of the (multi-status) response, # and are not being included again. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -313,7 +313,7 @@ class HTTPAlreadyReported < HTTPSuccess # for the resource, and the response is a representation of the result # of one or more instance-manipulations applied to the current instance. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -329,7 +329,7 @@ class HTTPIMUsed < HTTPSuccess # The Multiple Choices response indicates that the server # offers multiple options for the resource from which the client may choose. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -347,7 +347,7 @@ class HTTPMultipleChoices < HTTPRedirection # The Moved Permanently response indicates that links or records # returning this response should be updated to use the given URL. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -364,7 +364,7 @@ class HTTPMovedPermanently < HTTPRedirection # The Found response indicates that the client # should look at (browse to) another URL. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -381,7 +381,7 @@ class HTTPFound < HTTPRedirection # # The response to the request can be found under another URI using the GET method. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -398,7 +398,7 @@ class HTTPSeeOther < HTTPRedirection # Indicates that the resource has not been modified since the version # specified by the request headers. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -415,7 +415,7 @@ class HTTPNotModified < HTTPRedirection # The requested resource is available only through a proxy, # whose address is provided in the response. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -431,7 +431,7 @@ class HTTPUseProxy < HTTPRedirection # The request should be repeated with another URI; # however, future requests should still use the original URI. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -447,7 +447,7 @@ class HTTPTemporaryRedirect < HTTPRedirection # # This and all future requests should be directed to the given URI. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -463,7 +463,7 @@ class HTTPPermanentRedirect < HTTPRedirection # # The server cannot or will not process the request due to an apparent client error. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -479,7 +479,7 @@ class HTTPBadRequest < HTTPClientError # # Authentication is required, but either was not provided or failed. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -495,7 +495,7 @@ class HTTPUnauthorized < HTTPClientError # # Reserved for future use. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -512,7 +512,7 @@ class HTTPPaymentRequired < HTTPClientError # The request contained valid data and was understood by the server, # but the server is refusing action. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -528,7 +528,7 @@ class HTTPForbidden < HTTPClientError # # The requested resource could not be found but may be available in the future. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -544,7 +544,7 @@ class HTTPNotFound < HTTPClientError # # The request method is not supported for the requested resource. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -561,7 +561,7 @@ class HTTPMethodNotAllowed < HTTPClientError # The requested resource is capable of generating only content # that not acceptable according to the Accept headers sent in the request. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -577,7 +577,7 @@ class HTTPNotAcceptable < HTTPClientError # # The client must first authenticate itself with the proxy. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -593,7 +593,7 @@ class HTTPProxyAuthenticationRequired < HTTPClientError # # The server timed out waiting for the request. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -610,7 +610,7 @@ class HTTPRequestTimeout < HTTPClientError # # The request could not be processed because of conflict in the current state of the resource. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -627,7 +627,7 @@ class HTTPConflict < HTTPClientError # The resource requested was previously in use but is no longer available # and will not be available again. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -644,7 +644,7 @@ class HTTPGone < HTTPClientError # The request did not specify the length of its content, # which is required by the requested resource. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -661,7 +661,7 @@ class HTTPLengthRequired < HTTPClientError # The server does not meet one of the preconditions # specified in the request headers. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -677,7 +677,7 @@ class HTTPPreconditionFailed < HTTPClientError # # The request is larger than the server is willing or able to process. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -694,7 +694,7 @@ class HTTPPayloadTooLarge < HTTPClientError # # The URI provided was too long for the server to process. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -712,7 +712,7 @@ class HTTPURITooLong < HTTPClientError # # The request entity has a media type which the server or resource does not support. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -728,7 +728,7 @@ class HTTPUnsupportedMediaType < HTTPClientError # # The request entity has a media type which the server or resource does not support. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -745,7 +745,7 @@ class HTTPRangeNotSatisfiable < HTTPClientError # # The server cannot meet the requirements of the Expect request-header field. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -766,7 +766,7 @@ class HTTPExpectationFailed < HTTPClientError # # The request was directed at a server that is not able to produce a response. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -781,7 +781,7 @@ class HTTPMisdirectedRequest < HTTPClientError # # The request was well-formed but had semantic errors. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -797,7 +797,7 @@ class HTTPUnprocessableEntity < HTTPClientError # # The requested resource is locked. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -813,7 +813,7 @@ class HTTPLocked < HTTPClientError # The request failed because it depended on another request and that request failed. # See {424 Failed Dependency (WebDAV)}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#424]. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -831,7 +831,7 @@ class HTTPFailedDependency < HTTPClientError # # The client should switch to the protocol given in the Upgrade header field. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -847,7 +847,7 @@ class HTTPUpgradeRequired < HTTPClientError # # The origin server requires the request to be conditional. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -863,7 +863,7 @@ class HTTPPreconditionRequired < HTTPClientError # # The user has sent too many requests in a given amount of time. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -880,7 +880,7 @@ class HTTPTooManyRequests < HTTPClientError # An individual header field is too large, # or all the header fields collectively, are too large. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -897,7 +897,7 @@ class HTTPRequestHeaderFieldsTooLarge < HTTPClientError # A server operator has received a legal demand to deny access to a resource or to a set of resources # that includes the requested resource. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -917,7 +917,7 @@ class HTTPUnavailableForLegalReasons < HTTPClientError # # An unexpected condition was encountered and no more specific message is suitable. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -934,7 +934,7 @@ class HTTPInternalServerError < HTTPServerError # The server either does not recognize the request method, # or it lacks the ability to fulfil the request. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -951,7 +951,7 @@ class HTTPNotImplemented < HTTPServerError # The server was acting as a gateway or proxy # and received an invalid response from the upstream server. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -968,7 +968,7 @@ class HTTPBadGateway < HTTPServerError # The server cannot handle the request # (because it is overloaded or down for maintenance). # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -985,7 +985,7 @@ class HTTPServiceUnavailable < HTTPServerError # The server was acting as a gateway or proxy # and did not receive a timely response from the upstream server. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -1002,7 +1002,7 @@ class HTTPGatewayTimeout < HTTPServerError # # The server does not support the HTTP version used in the request. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -1018,7 +1018,7 @@ class HTTPVersionNotSupported < HTTPServerError # # Transparent content negotiation for the request results in a circular reference. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -1034,7 +1034,7 @@ class HTTPVariantAlsoNegotiates < HTTPServerError # # The server is unable to store the representation needed to complete the request. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -1050,7 +1050,7 @@ class HTTPInsufficientStorage < HTTPServerError # # The server detected an infinite loop while processing the request. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -1067,7 +1067,7 @@ class HTTPLoopDetected < HTTPServerError # # Further extensions to the request are required for the server to fulfill it. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: # @@ -1083,7 +1083,7 @@ class HTTPNotExtended < HTTPServerError # # The client needs to authenticate to gain network access. # - # :include: doc/net-http/included_getters.rdoc + # :include: ../../../doc/net-http/included_getters.rdoc # # References: #