Add link to detailed Net::HTTP documentation in README Usage section#276
Open
tkf0029 wants to merge 1 commit intoruby:masterfrom
Open
Add link to detailed Net::HTTP documentation in README Usage section#276tkf0029 wants to merge 1 commit intoruby:masterfrom
tkf0029 wants to merge 1 commit intoruby:masterfrom
Conversation
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
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.
Problem
When looking at the README on GitHub, it's unclear where to find more detailed information.
The README for the
Net::HTTPgem includes the following sections:The file net-http/doc/net-http/examples.rdoc also contains some simple usage examples.
However, it is not clear where to look for following information:
getorpost_formmethods used in the sample code:Objective
To allow users of the
net-httpgem to easily find detailed information and sample code for implementing basic HTTP requests usingnet-http.Proposal
Add a link at the bottom of the README's Usage section pointing to documentation with more detailed information.
The link is added only, without duplicating examples from rdoc, to avoid divergence between the README and official documentation.