Skip to content

Commit 0512b5b

Browse files
committed
About the Examples moved to separate file
1 parent a1b7031 commit 0512b5b

File tree

4 files changed

+32
-52
lines changed

4 files changed

+32
-52
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
/.yardoc
33
/_yardoc/
44
/coverage/
5-
/doc/
65
/pkg/
76
/spec/reports/
87
/tmp/

doc/net-http/examples.rdoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Examples here assume that <tt>net/http</tt> has been required
2+
(which also requires +uri+):
3+
4+
require 'net/http'
5+
6+
Many code examples here use these example websites:
7+
8+
- https://jsonplaceholder.typicode.com.
9+
- http://example.com.
10+
11+
Some examples also assume these variables:
12+
13+
uri = URI('https://jsonplaceholder.typicode.com')
14+
uri.freeze # Examples may not modify.
15+
hostname = uri.hostname # => "jsonplaceholder.typicode.com"
16+
port = uri.port # => 443
17+
18+
So that example requests may be written as:
19+
20+
Net::HTTP.get(uri)
21+
Net::HTTP.get(hostname, '/index.html')
22+
Net::HTTP.start(hostname) do |http|
23+
http.get('/todos/1')
24+
http.get('/todos/2')
25+
end
26+
27+
An example that needs a modified URI first duplicates +uri+, then modifies the duplicate:
28+
29+
_uri = uri.dup
30+
_uri.path = '/todos/1'

lib/net/http.rb

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -98,36 +98,7 @@ class HTTPHeaderSyntaxError < StandardError; end
9898
#
9999
# == About the Examples
100100
#
101-
# Examples here assume that <tt>net/http</tt> has been required
102-
# (which also requires +uri+):
103-
#
104-
# require 'net/http'
105-
#
106-
# Many code examples here use these example websites:
107-
#
108-
# - https://jsonplaceholder.typicode.com.
109-
# - http://example.com.
110-
#
111-
# Some examples also assume these variables:
112-
#
113-
# uri = URI('https://jsonplaceholder.typicode.com')
114-
# uri.freeze # Examples may not modify.
115-
# hostname = uri.hostname # => "jsonplaceholder.typicode.com"
116-
# port = uri.port # => 443
117-
#
118-
# So that example requests may be written as:
119-
#
120-
# Net::HTTP.get(uri)
121-
# Net::HTTP.get(hostname, '/index.html')
122-
# Net::HTTP.start(hostname) do |http|
123-
# http.get('/todos/1')
124-
# http.get('/todos/2')
125-
# end
126-
#
127-
# An example that needs a modified URI first duplicates +uri+, then modifies:
128-
#
129-
# _uri = uri.dup
130-
# _uri.path = '/todos/1'
101+
# :include: doc/net-http/examples.rdoc
131102
#
132103
# == URIs
133104
#

lib/net/http/response.rb

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,7 @@
44
#
55
# == About the Examples
66
#
7-
# Examples here assume that <tt>net/http</tt> has been required
8-
# (which also requires +uri+):
9-
#
10-
# require 'net/http'
11-
#
12-
# Many code examples here use these example websites:
13-
#
14-
# - https://jsonplaceholder.typicode.com.
15-
# - http://example.com.
16-
#
17-
# Some examples also assume these variables:
18-
#
19-
# uri = URI('https://jsonplaceholder.typicode.com')
20-
# uri.freeze # Examples may not modify.
21-
# hostname = uri.hostname # => "jsonplaceholder.typicode.com"
22-
# port = uri.port # => 443
23-
#
24-
# An example that needs a modified URI first duplicates +uri+, then modifies:
25-
#
26-
# _uri = uri.dup
27-
# _uri.path = '/todos/1'
7+
# :include: doc/net-http/examples.rdoc
288
#
299
# == Returned Responses
3010
#

0 commit comments

Comments
 (0)