Fix rendering of chrome.gcm senderIds type. #52
Merged
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.
Overview
Improves rendering of the chrome.gcm senderIds type in the chrome.gcm.register function.
Thought Process
When generating the chrome.gcm docs, we were previously seeing the following in the gcm.json spec:
And generating a union of all possible array lengths.
While it would be nice to have proper rendering for this in the future (e.g a min and max length tag) this PR implements a temporary solution where we simply collapse the type to X[] when we see more than 10 (an arbitrary but reasonable sound number) possible types. This seems reasonable since chrome.gcm is currently the only API with this problem (I checked) and the comments already explain the limit in detail.
Additional Details
Fixes GoogleChrome/developer.chrome.com#1850
Fixes GoogleChrome/developer.chrome.com#5176