Skip to content

Add link to detailed Net::HTTP documentation in README Usage section #276

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

Merged
kou merged 2 commits into from
Feb 19, 2026
+2 −0
Merged

Add link to detailed Net::HTTP documentation in README Usage section #276

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb98b13
add-information-link
tkf0029 Feb 13, 2026
23fbdb9
update the link and the text
tkf0029 Feb 16, 2026
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ res = Net::HTTP.post_form(uri, 'q' => ['ruby', 'perl'], 'max' => '50')
puts res.body
```

[For more information](https://docs.ruby-lang.org/en/4.0/Net/HTTP.html#public-class-methods)
Copy link
Copy Markdown
Member

@kou kou Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • How about using .../master/... not .../4.0/... because we don't want to maintain the version number here?
  • Can we remove #public-class-methods? It seems that it's not useful here.

Copy link
Copy Markdown
Contributor Author

@tkf0029 tkf0029 Feb 16, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you the suggesions.

1. About using .../master/... instead of .../4.0/...

  • You're right — maintaining a specific version number in the README would require updates whenever the version changes. I’ll update the link to use .../master/... instead.

2. About removing #public-class-methods

  • I originally added the heading anchor because the examples in the README use class methods, and I personally hesitated about where to look in the documentation. However:
    • Jumping directly to a specific section may feel a bit abrupt.
    • The fragment (#public-class-methods) could change in the future.
  • For these reasons, I’ll replace it with a link to the top-level documentation page without the fragment


## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand Down