Improve polygon and line documentation. #824
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
This should make it clearer what the position, line, and polygon accessors do. It also explicitly defines a polygon data type.
aashish24
reviewed
May 28, 2018
src/lineFeature.js
Outdated
| * @param {object|function} [val] If specified, use this for the line | ||
| * accessor and return the feature. If not specified, return the current | ||
| * line. If a function, this is passed `(dataElement, dataIndex)` and | ||
| * returns an array of vertex elements. |
There was a problem hiding this comment.
returns or return? above the sentences read return.
There was a problem hiding this comment.
Is there a possibility that this sentence could be improved further (and the ones below)?
manthey
force-pushed
the
polygon-and-line-docs
branch
from
521d317 to
d715877
Compare
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.
This should make it clearer what the position, line, and polygon accessors do. It also explicitly defines a polygon data type.