Skip to content
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.

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

[DOC] Enhanced RDoc for Net::HTTP #84

Merged
merged 3 commits into from
Dec 4, 2022
Merged

[DOC] Enhanced RDoc for Net::HTTP #84

merged 3 commits into from
Dec 4, 2022

Conversation

BurdetteLamar
Copy link
Member

Adds documentation for classes Net::HTTP::verb for 15 verbs (HTTP and WebDAV). Adds links to those pages from Net::HTTPRequest.

Reviewers, you can verify the given properties at https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Properties_of_request_methods_table.

@BurdetteLamar BurdetteLamar added the documentation Improvements or additions to documentation label Dec 2, 2022
lib/net/http/requests.rb Outdated Show resolved Hide resolved
lib/net/http/requests.rb Outdated Show resolved Hide resolved
lib/net/http/requests.rb Outdated Show resolved Hide resolved
#
# Related:
#
# - Net::HTTP.delete: sends +DELETE+ request, returns response object.
Copy link
Member

Choose a reason for hiding this comment

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

There also doesn't seem to be a Net::HTTP.delete method.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

#
# Related:
#
# - Net::HTTP.options: sends +OPTIONS+ request, returns response object.
Copy link
Member

Choose a reason for hiding this comment

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

Ditto on no method.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

#
# Related:
#
# - Net::HTTP.trace: sends +TRACE+ request, returns response object.
Copy link
Member

Choose a reason for hiding this comment

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

Ditto on not existing.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

#
# Related:
#
# - Net::HTTP.patch: sends +PATCH+ request, returns response object.
Copy link
Member

Choose a reason for hiding this comment

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

Ditto on not existing.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

lib/net/http/requests.rb Outdated Show resolved Hide resolved
Copy link
Member

@peterzhu2118 peterzhu2118 left a comment

Choose a reason for hiding this comment

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

There's still a few comments about methods that don't seem to exist that you haven't resolved yet.

@BurdetteLamar
Copy link
Member Author

There's still a few comments about methods that don't seem to exist that you haven't resolved yet.

I don;t know what to say, other than, "Yes, you're right." They're not here, but that's not for a documentation PR to deal with (even if it needs to be dealt with).

@peterzhu2118
Copy link
Member

I'm not sure I understand what you mean? You're mentioning methods that don't exist in the "Related" section.

@BurdetteLamar
Copy link
Member Author

@peterzhu2118, ready for you now.

@peterzhu2118 peterzhu2118 merged commit 6600463 into ruby:master Dec 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

2 participants