[DOC] Enhanced RDoc for Net:HTTP#124
Merged
peterzhu2118 merged 3 commits intoruby:masterfrom Feb 22, 2023
BurdetteLamar:http_doc
Merged
[DOC] Enhanced RDoc for Net:HTTP#124peterzhu2118 merged 3 commits intoruby:masterfrom BurdetteLamar:http_doc
peterzhu2118 merged 3 commits intoruby:masterfrom
BurdetteLamar:http_doc
Conversation
lib/net/http.rb
Outdated
|
|
||
| # Returns the continue timeout value. | ||
| # See Net::HTTP.continue_timeout=. | ||
| # See Net::HTTP.continue_timeout=. |
Member
There was a problem hiding this comment.
Please remove the trailing space.
Suggested change
| # See Net::HTTP.continue_timeout=. | |
| # See Net::HTTP.continue_timeout=. |
lib/net/http.rb
Outdated
Comment on lines
1856
to
1863
| # With no block given, returns the response object (with the body already read): | ||
| # | ||
| # This method never raises Net::* exceptions. | ||
| # http = Net::HTTP.new(hostname) | ||
| # http.request_get('/todos') # => #<Net::HTTPOK 200 OK readbody=true> | ||
| # | ||
| # response = http.request_get('/index.html') | ||
| # # The entity body is already read in this case. | ||
| # p response['content-type'] | ||
| # puts response.body | ||
| # With a block given, calls the block with the response object | ||
| # (with the body _not_ already read), | ||
| # and returns the response object (_with_ the body already read): |
Member
There was a problem hiding this comment.
I don't think talking about whether the body has been read is important. It's an internal state that isn't publicly exposed (except in the output string of Net::HTTPResponse#inspect). So I'm not sure what the value of talking about it is.
peterzhu2118
approved these changes
Feb 22, 2023
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Feb 22, 2023
nagachika
added a commit
to nagachika/ruby
that referenced
this pull request
Dec 16, 2023
…678d61a597fc2871031d7a38698f3dd63d8c29,44b7fd8d4fa842523813195dfb7255ce33fdf9ca,308942920f4e200468673be03c646f0645a84263,401aa9ddd1091f5b517dce37cd002bc2c37f5ac1,8250b4679453c095eab2f60d9147ca2fe4da32c6,fe7d4eed2511ff64f263d9f29cbf0dcbd4c3a026,d92289f6330c57b0fe970a654dbf33314bfd6203,3ebc80314cf1ce727dcc2ba4192ff5265d348206,5a9e2f142d9debfb44d7d23f6821b810607d9d15,3e5a77f1ae73f4a6bf7b2b868be674ab8c714c7a,faa4c2279aa018a2bb9bc09107adf8a8fcf5fd3d,6db79aefec27035583c5b236d98425748b428c49,06195e76037b500eac219b58506e34f0d852b472,a641f6422c97a72640dc295f6b1b3ec2b9da739e,2c7fe9c0a6a2cea1243dcb30e684bf8c016f1192,bc6e587e86a4a4a46af3b1c2fbe1ff3b399735a6,3c7d5ccdce5707d7964f01f974db505d5add590f,847a0df058a4adb60266213cb8db7bb537c1d09e,a49bc73e1f33e8a0e40ff0c3fef6c6fe749f8179,899fad907c32b533bb73206d5e19204e526621ba,4edb2a29f67957fc7027eaad0c08e8003cfde609,7c47c2617a091e2a7abaeff329fdef47d1f3f3f5,05f016cdad84481c084543c6fa8b32205c19431f,6e6992e5db49a238baf290d9b9b521f6b6be5a19: [ruby/net-http] Adding links to references ruby/net-http@b85530e6b8 --- lib/net/http/responses.rb | 206 ++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 180 insertions(+), 26 deletions(-) [ruby/net-http] [DOC] Adding links to references (ruby/net-http#97) ruby/net-http@768115167a --- lib/net/http/responses.rb | 83 ++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 72 insertions(+), 11 deletions(-) [ruby/net-http] Adding links to references ruby/net-http@1c8151aaf3 --- lib/net/http/responses.rb | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) [ruby/net-http] Enhanced RDoc for HTTPHeader ruby/net-http@6a282eccdd --- lib/net/http/header.rb | 39 +++++++++++++++++++++++++++++---------- 1 file changed, 29 insertions(+), 10 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for set_form (ruby/net-http#103) ruby/net-http@f6506ff889 --- lib/net/http/header.rb | 152 +++++++++++++++++++++++++++++++++---------------- 1 file changed, 102 insertions(+), 50 deletions(-) [ruby/net-http] [DOC] Header doc (ruby/net-http#104) ruby/net-http@3308362d9b --- lib/net/http/header.rb | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) [ruby/net-http] Correct doc error ruby/net-http@dc006d8419 --- lib/net/http/response.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) Manually merged ruby/net-http#106 Co-authored-by: Peter Zhu <peter@peterzhu.ca> Co-authored-by: BurdetteLamar <burdettelamar@yahoo.com> --- lib/net/http.rb | 109 +++++++++++++++++++++++++++----------------------------- 1 file changed, 52 insertions(+), 57 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP (ruby/net-http#110) ruby/net-http@b098caa5e4 --- doc/net-http/examples.rdoc | 3 +- lib/net/http.rb | 166 +++++++++++++++++++++------------------------ 2 files changed, 78 insertions(+), 91 deletions(-) [ruby/net-http] Redirection revision ruby/net-http@9a4e2d3a2a --- lib/net/http.rb | 62 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 30 insertions(+), 32 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for HTTPGenericRequest (ruby/net-http#113) ruby/net-http@14c8405702 --- lib/net/http/generic_request.rb | 92 +++++++++++++++++++++++++++++++++++++---- 1 file changed, 84 insertions(+), 8 deletions(-) [ruby/net-http] Remarks on inclusions ruby/net-http@dfd060c583 --- doc/net-http/included_getters.rdoc | 3 + doc/net-http/included_setters.rdoc | 3 + lib/net/http/requests.rb | 30 ++++++++++ lib/net/http/responses.rb | 120 +++++++++++++++++++++++++++++++++++++ 4 files changed, 156 insertions(+) create mode 100644 doc/net-http/included_getters.rdoc create mode 100644 doc/net-http/included_setters.rdoc [ruby/net-http] [DOC] Enhanced RDoc for write_timeout (ruby/net-http#115) ruby/net-http@6da39b0461 --- lib/net/http.rb | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP (ruby/net-http#116) ruby/net-http@22c0d34002 --- lib/net/http.rb | 78 +++++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 59 insertions(+), 19 deletions(-) * remove trailing spaces. [ci skip] --- lib/net/http.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) [ruby/net-http] [DOC] Reorganize doc for proxy server (ruby/net-http#117) ruby/net-http@f8b6b76cba --- lib/net/http.rb | 198 ++++++++++++++++++++++++++++---------------------------- 1 file changed, 100 insertions(+), 98 deletions(-) [ruby/net-http] Enhanced RDoc for Net::HTTP ruby/net-http@e65a3d9f11 --- lib/net/http.rb | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) [ruby/net-http] Enhanced RDoc for Compression ruby/net-http@cff88acd70 --- lib/net/http.rb | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for request headers (ruby/net-http#120) ruby/net-http@b4eb8a7932 --- doc/net-http/included_setters.rdoc | 3 --- lib/net/http/request.rb | 53 +++++++++++++++++++++++++++++++++++--- lib/net/http/requests.rb | 30 ++++++++++----------- 3 files changed, 64 insertions(+), 22 deletions(-) delete mode 100644 doc/net-http/included_setters.rdoc [ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP#get (ruby/net-http#121) ruby/net-http@51b9af1eed --- lib/net/http.rb | 53 +++++++++++++++++++++++------------------------------ 1 file changed, 23 insertions(+), 30 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP (ruby/net-http#122) ruby/net-http@06f79cda87 --- lib/net/http.rb | 91 ++++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 57 insertions(+), 34 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP (ruby/net-http#123) ruby/net-http@220ff3f741 --- lib/net/http.rb | 118 +++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 96 insertions(+), 22 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for Net:HTTP (ruby/net-http#124) ruby/net-http@aaf26b21d6 --- lib/net/http.rb | 35 ++++++++++++++++------------------- 1 file changed, 16 insertions(+), 19 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP (ruby/net-http#125) ruby/net-http@2ea20380fc --- lib/net/http.rb | 130 +++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 87 insertions(+), 43 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP (ruby/net-http#126) ruby/net-http@4700d0660b --- lib/net/http.rb | 87 +++++++++++++++++++++++++++++++------------------- lib/net/http/status.rb | 2 +- 2 files changed, 55 insertions(+), 34 deletions(-) [ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP (ruby/net-http#127) ruby/net-http@07b2b88ef5 --- lib/net/http.rb | 65 +++++++++++++++++++++++++++++++-------------------------- 1 file changed, 35 insertions(+), 30 deletions(-)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Treats #request_get.