Documentation improvements and cleanup #1891
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
| * A function used to compare two items while sorting a queue. | ||
| * @callback Queue~Comparator | ||
| * | ||
| * @param {Object} a An item in the array. |
There was a problem hiding this comment.
Would it be better to use left and right here instead of a and b? That's the convention we seem to use elsewhere.
There was a problem hiding this comment.
left and right make somewhat more sense for something like equals, which in better languages would be defined as infix operators, e.g. left == right. Comparison functions seem to generally be different. MDN for JavaScript uses a, b. Java uses o1, o2. .NET uses x, y.
|
Other than the couple of minor comments, this looks good to me. |
mramato
added a commit
that referenced
this pull request
Jul 7, 2014
Documentation improvements and cleanup
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.
Functionbecause they don't have a strict interface. For example, the signature of anEventlistener varies from instance to instance.@namespacesyntax instead of@exports.@exports. Going forward,@exportsare assumed to be free functions.