Skip to content

Update RBS markdown annotations #310

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

Open
seanpdoyle wants to merge 1 commit into
base: master
Choose a base branch
from
+59 −80
Open

Update RBS markdown annotations #310

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
139 changes: 59 additions & 80 deletions sig/net-http.rbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ module Net
#
# * [Hypertext Transfer
# Protocol](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol).
# * [Technical
# overview](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Techni
# cal_overview).
# * [Technology](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Tec
# hnology).
#
# ## About the Examples
#
Expand Down Expand Up @@ -56,7 +55,7 @@ module Net
# ## Strategies
#
# * If you will make only a few GET requests, consider using
# [OpenURI](rdoc-ref:OpenURI).
# [OpenURI](https://docs.ruby-lang.org/en/master/OpenURI.html).
# * If you will make only a few requests of all kinds, consider using the
# various singleton convenience methods in this class. Each of the following
# methods automatically starts and finishes a
Expand All @@ -83,9 +82,8 @@ module Net
# * If performance is important, consider using sessions, which lower request
# overhead. This [session](rdoc-ref:Net::HTTP@Sessions) has multiple
# requests for [HTTP
# methods](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request
# _methods) and [WebDAV
# methods](https://en.wikipedia.org/wiki/WebDAV#Implementation):
# methods](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Method)
# and [WebDAV methods](https://en.wikipedia.org/wiki/WebDAV#Implementation):
#
# Net::HTTP.start(hostname) do |http|
# # Session started automatically before block execution.
Expand Down Expand Up @@ -120,9 +118,9 @@ module Net
# scheme, hostname, path, query, and fragment; see [URI
# syntax](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#Syntax).
#
# A Ruby [URI::Generic](rdoc-ref:URI::Generic) object represents an internet
# URI. It provides, among others, methods `scheme`, `hostname`, `path`, `query`,
# and `fragment`.
# A Ruby [URI::Generic](https://docs.ruby-lang.org/en/master/URI/Generic.html)
# object represents an internet URI. It provides, among others, methods
# `scheme`, `hostname`, `path`, `query`, and `fragment`.
#
# ### Schemes
#
Expand Down Expand Up @@ -212,8 +210,8 @@ module Net
# single request:
#
# * [HTTP
# methods](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request
# _methods):
# methods](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Method)
# :
#
# * #get, #request_get: GET.
# * #head, #request_head: HEAD.
Expand Down Expand Up @@ -462,8 +460,8 @@ module Net
# has header <code>'Content-Range'</code>.
#
# Otherwise decompression (or not) depends on the value of header
# [Content-Encoding](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#co
# ntent-encoding-response-header):
# [Content-Encoding](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Co
# ntent-Encoding_2):
#
# * <code>'deflate'</code>, <code>'gzip'</code>, or <code>'x-gzip'</code>:
# decompresses the body and deletes the header.
Expand All @@ -475,7 +473,9 @@ module Net
#
# First, what's elsewhere. Class Net::HTTP:
#
# * Inherits from [class Object](rdoc-ref:Object@What-27s+Here).
# * Inherits from [class
# Object](https://docs.ruby-lang.org/en/master/Object.html#class-object-what
# s-here).
#
# This is a categorized summary of methods and attributes.
#
Expand Down Expand Up @@ -1116,8 +1116,8 @@ module Net

# <!-- rdoc-file=lib/net/http.rb -->
# Sets whether to determine the proxy from environment variable
# '<code>ENV['http_proxy']</code>'; see {Proxy Using
# [ENV]('http_proxy')}[Net::HTTP@Proxy+Using+-27ENV-5B-27http_proxy-27-5D-27].
# '<code>ENV['http_proxy']</code>'; see [Proxy Using
# ENV](rdoc-ref:Net::HTTP@Proxy+Using+ENVHTTPProxy).
#
attr_writer proxy_from_env: untyped

Expand Down Expand Up @@ -1357,15 +1357,16 @@ module Net

# <!-- rdoc-file=lib/net/http.rb -->
# Sets or returns the available SSL ciphers. See
# [OpenSSL::SSL::SSLContext#ciphers=](OpenSSL::SSL::SSL::Context#ciphers=).
# [OpenSSL::SSL::SSLContext#ciphers=](https://docs.ruby-lang.org/en/master/OpenS
# SL/SSL/SSLContext.html#method-i-ciphers-3D).
#
attr_accessor ciphers: untyped

# <!-- rdoc-file=lib/net/http.rb -->
# Sets or returns the extra X509 certificates to be added to the certificate
# chain. See
# [OpenSSL::SSL::SSLContext#add_certificate](OpenSSL::SSL::SSL::Context#add_cert
# ificate).
# [OpenSSL::SSL::SSLContext#add_certificate](https://docs.ruby-lang.org/en/maste
# r/OpenSSL/SSL/SSLContext.html#method-i-add_certificate).
#
attr_accessor extra_chain_cert: untyped

Expand All @@ -1381,22 +1382,22 @@ module Net

# <!-- rdoc-file=lib/net/http.rb -->
# Sets or returns the SSL version. See
# [OpenSSL::SSL::SSLContext#ssl_version=](OpenSSL::SSL::SSL::Context#ssl_version
# =).
# [OpenSSL::SSL::SSLContext#ssl_version=](https://docs.ruby-lang.org/en/master/O
# penSSL/SSL/SSLContext.html#method-i-ssl_version-3D).
#
attr_accessor ssl_version: untyped

# <!-- rdoc-file=lib/net/http.rb -->
# Sets or returns the minimum SSL version. See
# [OpenSSL::SSL::SSLContext#min_version=](OpenSSL::SSL::SSL::Context#min_version
# =).
# [OpenSSL::SSL::SSLContext#min_version=](https://docs.ruby-lang.org/en/master/O
# penSSL/SSL/SSLContext.html#method-i-min_version-3D).
#
attr_accessor min_version: untyped

# <!-- rdoc-file=lib/net/http.rb -->
# Sets or returns the maximum SSL version. See
# [OpenSSL::SSL::SSLContext#max_version=](OpenSSL::SSL::SSL::Context#max_version
# =).
# [OpenSSL::SSL::SSLContext#max_version=](https://docs.ruby-lang.org/en/master/O
# penSSL/SSL/SSLContext.html#method-i-max_version-3D).
#
attr_accessor max_version: untyped

Expand All @@ -1420,8 +1421,8 @@ module Net
# <!-- rdoc-file=lib/net/http.rb -->
# Sets or returns whether to verify that the server certificate is valid for the
# hostname. See
# [OpenSSL::SSL::SSLContext#verify_hostname=](OpenSSL::SSL::SSL::Context#verify_
# hostname=).
# [OpenSSL::SSL::SSLContext#verify_hostname=](https://docs.ruby-lang.org/en/mast
# er/OpenSSL/SSL/SSLContext.html#attribute-i-verify_hostname).
#
attr_accessor verify_hostname: untyped

Expand Down Expand Up @@ -2623,7 +2624,7 @@ module Net
# "Cf-Ray"
#
# The capitalization is system-dependent; see [Case
# Mapping](rdoc-ref:case_mapping.rdoc).
# Mapping](https://docs.ruby-lang.org/en/master/case_mapping_rdoc.html).
#
# Returns an enumerator if no block is given.
#
Expand Down Expand Up @@ -2968,7 +2969,8 @@ module Net
# The resulting request is suitable for HTTP request `POST` or `PUT`.
#
# Argument `params` must be suitable for use as argument `enum` to
# [URI.encode_www_form](rdoc-ref:URI.encode_www_form).
# [URI.encode_www_form](https://docs.ruby-lang.org/en/master/URI.html#method-c-e
# ncode_www_form).
#
# With only argument `params` given, sets the body to a URL-encoded string with
# the default separator <code>'&'</code>:
Expand Down Expand Up @@ -3018,8 +3020,9 @@ module Net
# * An IO stream opened for reading.
#
# Argument `params` should be an
# [Enumerable](rdoc-ref:Enumerable@Enumerable+in+Ruby+Classes) (method
# <code>params.map</code> will be called), and is often an array or hash.
# [Enumerable](https://docs.ruby-lang.org/en/master/Enumerable.html#module-Enume
# rable-label-Enumerable+in+Ruby+Classes) (method <code>params.map</code> will
# be called), and is often an array or hash.
#
# First, we set up a request:
#
Expand Down Expand Up @@ -3278,12 +3281,9 @@ module Net
#
# * Request body: optional.
# * Response body: yes.
# * [Safe](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_meth
# ods): yes.
# * [Idempotent](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Ide
# mpotent_methods): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cach
# eable_methods): yes.
# * [Safe](https://en.wikipedia.org/wiki/HTTP#Safe_method): yes.
# * [Idempotent](https://en.wikipedia.org/wiki/HTTP#Idempotent_method): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/HTTP#Cacheable_method): yes.
#
# Related:
#
Expand Down Expand Up @@ -3317,12 +3317,9 @@ module Net
#
# * Request body: optional.
# * Response body: no.
# * [Safe](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_meth
# ods): yes.
# * [Idempotent](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Ide
# mpotent_methods): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cach
# eable_methods): yes.
# * [Safe](https://en.wikipedia.org/wiki/HTTP#Safe_method): yes.
# * [Idempotent](https://en.wikipedia.org/wiki/HTTP#Idempotent_method): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/HTTP#Cacheable_method): yes.
#
# Related:
#
Expand Down Expand Up @@ -3358,12 +3355,9 @@ module Net
#
# * Request body: yes.
# * Response body: yes.
# * [Safe](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_meth
# ods): no.
# * [Idempotent](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Ide
# mpotent_methods): no.
# * [Cacheable](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cach
# eable_methods): yes.
# * [Safe](https://en.wikipedia.org/wiki/HTTP#Safe_method): no.
# * [Idempotent](https://en.wikipedia.org/wiki/HTTP#Idempotent_method): no.
# * [Cacheable](https://en.wikipedia.org/wiki/HTTP#Cacheable_method): yes.
#
# Related:
#
Expand Down Expand Up @@ -3400,12 +3394,9 @@ module Net
#
# * Request body: yes.
# * Response body: yes.
# * [Safe](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_meth
# ods): no.
# * [Idempotent](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Ide
# mpotent_methods): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cach
# eable_methods): no.
# * [Safe](https://en.wikipedia.org/wiki/HTTP#Safe_method): no.
# * [Idempotent](https://en.wikipedia.org/wiki/HTTP#Idempotent_method): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/HTTP#Cacheable_method): no.
#
# Related:
#
Expand Down Expand Up @@ -3440,12 +3431,9 @@ module Net
#
# * Request body: optional.
# * Response body: yes.
# * [Safe](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_meth
# ods): no.
# * [Idempotent](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Ide
# mpotent_methods): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cach
# eable_methods): no.
# * [Safe](https://en.wikipedia.org/wiki/HTTP#Safe_method): no.
# * [Idempotent](https://en.wikipedia.org/wiki/HTTP#Idempotent_method): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/HTTP#Cacheable_method): no.
#
# Related:
#
Expand Down Expand Up @@ -3478,12 +3466,9 @@ module Net
#
# * Request body: optional.
# * Response body: yes.
# * [Safe](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_meth
# ods): yes.
# * [Idempotent](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Ide
# mpotent_methods): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cach
# eable_methods): no.
# * [Safe](https://en.wikipedia.org/wiki/HTTP#Safe_method): yes.
# * [Idempotent](https://en.wikipedia.org/wiki/HTTP#Idempotent_method): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/HTTP#Cacheable_method): no.
#
# Related:
#
Expand Down Expand Up @@ -3516,12 +3501,9 @@ module Net
#
# * Request body: no.
# * Response body: yes.
# * [Safe](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_meth
# ods): yes.
# * [Idempotent](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Ide
# mpotent_methods): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cach
# eable_methods): no.
# * [Safe](https://en.wikipedia.org/wiki/HTTP#Safe_method): yes.
# * [Idempotent](https://en.wikipedia.org/wiki/HTTP#Idempotent_method): yes.
# * [Cacheable](https://en.wikipedia.org/wiki/HTTP#Cacheable_method): no.
#
# Related:
#
Expand Down Expand Up @@ -3557,12 +3539,9 @@ module Net
#
# * Request body: yes.
# * Response body: yes.
# * [Safe](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_meth
# ods): no.
# * [Idempotent](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Ide
# mpotent_methods): no.
# * [Cacheable](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cach
# eable_methods): no.
# * [Safe](https://en.wikipedia.org/wiki/HTTP#Safe_method): no.
# * [Idempotent](https://en.wikipedia.org/wiki/HTTP#Idempotent_method): no.
# * [Cacheable](https://en.wikipedia.org/wiki/HTTP#Cacheable_method): no.
#
# Related:
#
Expand Down