feedback on pr 3518 #294
Merged
feedback on pr 3518 #294
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
peterbe
commented
Apr 21, 2021
peterbe
commented
Apr 21, 2021
peterbe
commented
Apr 21, 2021
peterbe
commented
Apr 21, 2021
| } | ||
| }); | ||
| console.log("HERE!!"); | ||
| console.log(specifications); |
peterbe
commented
Apr 21, 2021
| return { | ||
| bcdSpecificationURL: specURL, | ||
| title: spec.title, | ||
| shortTitle: spec.shortTitle, |
There was a problem hiding this comment.
The TypeScript React code assumes that title and shortTitle is always a string. THis might not be safe! I haven't looked deeper into browser-specs but could it be that some entries in there have null on the shortTitle, for example? If so we need to guard better.
There was a problem hiding this comment.
They use a schema to validate their data https://github.com/w3c/browser-specs/blob/master/schema/definitions.json. So, shortTitle is defined as a string.
I don't really know a lot about TypeScript but maybe it would make sense if browser-specs had a TypeScript definition file? I know BCD has this for that reason, too.
peterbe
commented
Apr 21, 2021
Elchi3
approved these changes
Apr 22, 2021
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 started doing some reviewing and to back up my comments I started playing with the code.
Eventually, I had enough code that it would just be easier to send it over like this.
I'll explain some reasoning within.