Update @param of methods on Connection
#1452
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Methods on `Connection` with the name of HTTP verb, such as `post`, depend on `run_request`, and it receives the following parameters: * `url` as `String`, `URI`, or `nil` (if it's omitted or explicitly set) * `body` as `String` or `nil` (if it's omitted or explicitly set) * `headers` as `Hash` or `nil` (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` of `run_request` as well as `Request#body` because the `body` will be passed to `Faraday::Env#new` through `Request#to_env`, and `Faraday::Env#body` seems `String`.
iMacTia
force-pushed
the
add-URI-nil-on-run_request
branch
from
70803eb
to
05cb204
Compare
iMacTia
approved these changes
Oct 3, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Connectionwith the name of HTTP verb, such aspost, depend onrun_request, and it receives the following parameters:urlasString,URI, ornil(if it's omitted or explicitly set)bodyasStringornil(if it's omitted or explicitly set)headersasHashornil(if it's omitted or explicitly set)I think the current YARD doc could be updated to follow the implemented behavior. Especially, the
URItype looks to be worth being described because the type is supported by `Request#url.Besides, I updated the
bodyofrun_requestas well asRequest#bodybecause thebodywill be passed toFaraday::Env#newthroughRequest#to_env, andFaraday::Env#bodyseemsString.Todos
[ ] Tests(This PR just updated the YARD doc)Additional Notes
Perhaps, other YARD comments could be updated, but I focused on
run_requestand its related methods.