This repository has been archived by the owner on Jan 9, 2023. It is now read-only.
Make optional params truly optional. #86
Open
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Many methods in the SDK currently require many optional parameters; these are usually the URL parameters that can be provided for paging or field inclusion.
This change makes parameters which are marked as and treated as optional in the SDK functionally optional as well, by providing the default values for those parameters.
C#'s implementation of default parameters allows this change to be made without breaking any existing code. It allows such code to be rewritten later if so desired, using positional and named parameters to improve clarity of intent and remove undesirable clutter, e.g. calls that end in
... , null, null, null)Of note: the existing tests were run as-is without leveraging optional params to verify that the changes to the SDK would not break existing calls. They were then adapted to take advantage of these optional params, allowing the tests to demonstrate the newly streamlined calls this feature enables.
Currently depends on #83 to ensure greater code coverage to test against these changes.