Fix incorrect json sigs
#3296
Merged
Fix incorrect json sigs
#3296
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
We are trying to update to json 2.3 (from 1.8). We use tapioca. After updating `json` and re-running `tapioca` we got these 3 errors from `srb tc`: ``` sorbet/rbi/gems/json@2.3.1.rbi:31: Method JSON.dump redefined without matching argument count. Expected: 2, got: 3 https://srb.help/4010 31 | def self.dump(obj, anIO = _, limit = _); end ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ https://github.com/sorbet/sorbet/tree/576e1fe628309d57783b13d7d7c7e7c546060b49/rbi/stdlib/json.rbi#L137: Previous definition 137 | def self.dump(obj, *args); end ^^^^^^^^^^^^^^^^^^^^^^^^^ sorbet/rbi/gems/json@2.3.1.rbi:36: Method JSON.generate redefined with argument opts as a non-splat argument https://srb.help/4010 36 | def self.generate(obj, opts = _); end ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ https://github.com/sorbet/sorbet/tree/576e1fe628309d57783b13d7d7c7e7c546060b49/rbi/stdlib/json.rbi#L193: The corresponding argument args in the previous definition was a splat argument 193 | def self.generate(obj, *args); end ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ sorbet/rbi/gems/json@2.3.1.rbi:47: Method JSON.pretty_generate redefined with argument opts as a non-splat argument https://srb.help/4010 47 | def self.pretty_generate(obj, opts = _); end ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ https://github.com/sorbet/sorbet/tree/576e1fe628309d57783b13d7d7c7e7c546060b49/rbi/stdlib/json.rbi#L312: The corresponding argument args in the previous definition was a splat argument 312 | def self.pretty_generate(obj, *args); end ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``` As far as I can tell, in every case tapioca's sig is correct, and matches the method sig in the [json gem](https://github.com/flori/json/blob/v2.3.1/lib/json/common.rb). Therefore I am updating the rbis to match.
|
We have a policy of testing changes to Sorbet against Stripe's codebase before Stripe employees can see the build result here: |
|
Thanks! This raised a few errors on Stripe's codebase, I'll have a look at addressing them on Monday. |
|
We have a policy of testing changes to Sorbet against Stripe's codebase before Stripe employees can see the build result here: |
marianosimone
approved these changes
Aug 6, 2020
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.
We are trying to update to json 2.3 (from 1.8). We use tapioca. After updating
jsonand re-runningtapiocawe got these 3 errors fromsrb tc:As far as I can tell, in every case tapioca's sig is correct, and matches the method sig in the json gem in versions 2.3.1 and 1.8.6. Therefore I am updating the rbis to match.