Introduce parameter object for API params that travel together #318
Conversation
This file contains hidden or 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
sampart
force-pushed
the
api-param-object
branch
2 times, most recently
from
91bd314 to
ecaefc3
Compare
sampart
force-pushed
the
api-param-object
branch
from
ecaefc3 to
20567b5
Compare
Previously, most tests were using https://github.com and only the first was using https://github.example.com. As it happens, https://github.com works for all of them.
robertbrignull
approved these changes
Nov 24, 2020
Contributor
robertbrignull
left a comment
robertbrignull
left a comment
There was a problem hiding this comment.
All changes look correct to me. Variables are going to the right places and there's no spurious changes.
I think this change is an improvement overall. It's not an improvement in terms of linecount but it makes each method definition and call-site more clear, and especially when methods delegate to each other and just pass the parameters on. It also removes a very real possibility of getting the auth/url parameters the wrong way around when calling a method.
Merged
Merged
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.
I've been thinking about how to slim down our long parameter lists, and noticed that we almost always pass
githubAuthandgithubUrlas a pair. This PR introduces an interface for a data object which holds those two, so we can slim down parameter lists and introduce a little more type safety.This change may not be worth the overhead it introduces, but I think it probably is.
Merge / deployment checklist