docs: Fix Player#src API documentation. #4454
Merged
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
mister-ben
reviewed
Jun 28, 2017
src/js/player.js
Outdated
| * @param {Tech~SourceObject|Tech~SourceObject[]|string} [source] | ||
| * A SourceObject, an array of SourceObjects, or a string referencing | ||
| * a URL to a media source. If not provided, this method acts as a | ||
| * getter. |
There was a problem hiding this comment.
Is it worth recommending using an object rather than a string here so that source selection can take account of the source's type?
misteroneill
force-pushed
the
fix-player-src-docs
branch
from
6428a63
to
9f41b94
Compare
mister-ben
approved these changes
Jul 6, 2017
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.
The API docs for
Player#srcare inaccurate/incomplete.Requirements Checklist