Small Refinements on Documentation #536
Conversation
toshi0383
commented
Sep 28, 2016
toshi0383
commented
- Add tutorial tag to shakaExtern.RetryParameters
- Add more description to Lisence Server Auth Sample Code
Properties like `backoffFactor` or `fuzzFactor` is a little difficult to understand for new users. Made it easier to figure out what it is.
|
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed, please reply here (e.g.
|
| @@ -89,6 +89,8 @@ We can use a request filter to modify the URL and add the required parameter: | |||
| // Only add headers to license requests: | |||
| if (type == shaka.net.NetworkingEngine.RequestType.LICENSE) { | |||
| // This is the specific parameter name and value the server wants: | |||
| // Note that there would be multiple uris for lisence server. | |||
There was a problem hiding this comment.
Small spelling error: "license". Also, it would be more accurate to say something like
"All network requests can have multiple URIs (for fallback), and therefore this is an array. But there should only be one license server URI."
|
CLAs look good, thanks! |
|
Fixed comment and rebased. |
| @@ -89,6 +89,10 @@ We can use a request filter to modify the URL and add the required parameter: | |||
| // Only add headers to license requests: | |||
| if (type == shaka.net.NetworkingEngine.RequestType.LICENSE) { | |||
| // This is the specific parameter name and value the server wants: | |||
| // Note that there would be multiple uris for license server. | |||
| // e.g. one for Widevine and one for PlayReady | |||
There was a problem hiding this comment.
I think this part is confusing. It implies that uris[0] might be Widevine, for example, while uris[1] might be PlayReady. This is not the case. For a license request, uris.length will always be 1, and uris[0] will always be the license server URI for the chosen key system.
There was a problem hiding this comment.
That's what I thought... I'll fix it.
| // Note that there would be multiple uris for license server. | ||
| // e.g. one for Widevine and one for PlayReady | ||
| // All network requests can have multiple URIs (for fallback), and | ||
| // therefore this is an array. But there should only be one license server URI. |
There was a problem hiding this comment.
Style nit: please wrap this line at 80 columns.
|
Fixed ! |
* Add tutorial tag to shakaExtern.RetryParameters Properties like `backoffFactor` or `fuzzFactor` is a little difficult to understand for new users. Link to the tutorial to explain. * Additional Description to Sample Code Explains why request.uris is an array.
github-actions
bot
added
the
status: archived
