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] New doc for responses classes #91

Merged
merged 3 commits into from
Dec 14, 2022
Merged

[DOC] New doc for responses classes #91

merged 3 commits into from
Dec 14, 2022

Conversation

BurdetteLamar
Copy link
Member

Documents subclasses of Net::HTTPResponse (removing :nodoc: and adding text), with a link
to a Wikipedia section for each. This also enables autolinking from HTTPResponse.html to those subclasses.

@BurdetteLamar BurdetteLamar added the documentation Improvements or additions to documentation label Dec 14, 2022
@@ -3,236 +3,601 @@
# https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

module Net
# :stopdoc:

class HTTPUnknownResponse < HTTPResponse
HAS_BODY = true
EXCEPTION_TYPE = HTTPError #
Copy link
Member

Choose a reason for hiding this comment

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

I realize that this isn't in scope of your PR, but do you know why these lines have an empty comment at the end of the line?

Copy link
Member Author

Choose a reason for hiding this comment

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

I do not know.

lib/net/http/responses.rb Outdated Show resolved Hide resolved
lib/net/http/responses.rb Outdated Show resolved Hide resolved
lib/net/http/responses.rb Outdated Show resolved Hide resolved
lib/net/http/responses.rb Outdated Show resolved Hide resolved

# Response class for <tt>Conflict</tt> responses (status code 409).
#
# The request could not be processed because of conflict in the current state of the resource
Copy link
Member

Choose a reason for hiding this comment

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

You're missing a period for this line.

Suggested change
# The request could not be processed because of conflict in the current state of the resource
# The request could not be processed because of conflict in the current state of the resource.

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.

@peterzhu2118 peterzhu2118 merged commit d394404 into ruby:master Dec 14, 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