Update @param
of methods on Connection
#1452
Merged
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.
Description
Methods on
Connection
with the name of HTTP verb, such aspost
, depend onrun_request
, and it receives the following parameters:url
asString
,URI
, ornil
(if it's omitted or explicitly set)body
asString
ornil
(if it's omitted or explicitly set)headers
asHash
ornil
(if it's omitted or explicitly set)I think the current YARD doc could be updated to follow the implemented behavior. Especially, the
URI
type looks to be worth being described because the type is supported by `Request#url.Besides, I updated the
body
ofrun_request
as well asRequest#body
because thebody
will be passed toFaraday::Env#new
throughRequest#to_env
, andFaraday::Env#body
seemsString
.Todos
[ ] Tests(This PR just updated the YARD doc)Additional Notes
Perhaps, other YARD comments could be updated, but I focused on
run_request
and its related methods.