Commit 262fb2f
authored
Add link to detailed Net::HTTP documentation in README Usage section (#276)
## Problem
When looking at the [README](https://github.com/ruby/net-http?tab=readme-ov-file) on GitHub, it's unclear where to find more detailed information.
The [README](https://github.com/ruby/net-http?tab=readme-ov-file#usage) for the `Net::HTTP` gem includes the following sections:
- Overview
- Installation
- Usage
- GET
- GET by URI
- GET with Dynamic Parameters
- POST
- POST with Multiple Values
- Development
- Contributing
The file [net-http/doc/net-http/examples.rdoc](https://github.com/ruby/net-http/blob/master/doc/net-http/examples.rdoc) also contains some simple usage examples.
However, it is not clear where to look for following information:
- Details of the `get` or `post_form` methods used in the sample code:
- Supported argument types
- Return values
- Other ways to implement GET or POST requests
- Links to documentation covering the above
---
## Objective
To allow users of the `net-http` gem to easily find detailed information and sample code for implementing basic [HTTP requests](https://developer.mozilla.org/ja/docs/Web/HTTP/Reference/Methods) using `net-http`.
---
## Proposal
Add a link at the bottom of the README's [Usage](https://github.com/ruby/net-http?tab=readme-ov-file#development) 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.1 parent 4ecc9c6 commit 262fb2f
1 file changed
Lines changed: 2 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
81 | 81 | | |
82 | 82 | | |
83 | 83 | | |
| 84 | + | |
| 85 | + | |
84 | 86 | | |
85 | 87 | | |
86 | 88 | | |
| |||
0 commit comments