Skip to content

Commit

Permalink
Reword some comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
manthey committed May 29, 2018
1 parent 1b60422 commit 521d317
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 18 deletions.
18 changes: 9 additions & 9 deletions src/lineFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@ var lineFeature = function (arg) {
/**
* Get/set line accessor.
*
* @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.
* @returns {object|function|this} The current line or this feature.
* @param {object|function} [val] If not specified, return the current line
* accessor. If specified, use this for the line accessor and return
* `this`. If a function is given, the function is passed `(dataElement,
* dataIndex)` and returns an array of vertex elements.
* @returns {object|function|this} The current line accessor or this feature.
*/
this.line = function (val) {
if (val === undefined) {
Expand All @@ -105,10 +105,10 @@ var lineFeature = function (arg) {
/**
* Get/Set position accessor.
*
* @param {object|function} [val] If specified, use this for the position
* accessor and return the feature. If not specified, return the current
* position. If a function, this is called with `(vertexElement,
* vertexIndex, dataElement, dataIndex)`.
* @param {object|function} [val] If not specified, return the current
* position accessor. If specified, use this for the position accessor
* and return `this`. If a function is given, this is called with
* `(vertexElement, vertexIndex, dataElement, dataIndex)`.
* @returns {object|function|this} The current position or this feature.
*/
this.position = function (val) {
Expand Down
19 changes: 10 additions & 9 deletions src/polygonFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,12 @@ var polygonFeature = function (arg) {
/**
* Get/set polygon accessor.
*
* @param {object|function} [val] If specified, use this for the polygon
* accessor and return the feature. If not specified, return the current
* polygon. If a function, this is passed `(dataElement, dataIndex)` and
* returns a `geo.polygon`.
* @returns {object|function|this} The current polygon or this feature.
* @param {object|function} [val] If not specified, return the current
* polygon accessor. If specified, use this for the polygon accessor and
* return `this`. If a function is given, the function is passed
* `(dataElement, dataIndex)` and returns a `geo.polygon`.
* @returns {object|function|this} The current polygon accessor or this
* feature.
*/
this.polygon = function (val) {
if (val === undefined) {
Expand All @@ -204,10 +205,10 @@ var polygonFeature = function (arg) {
/**
* Get/Set position accessor.
*
* @param {object} [val] If specified, use this for the position accessor
* and return the feature. If not specified, return the current
* position. If a function, this is called with `(vertexElement,
* vertexIndex, dataElement, dataIndex)`.
* @param {object|function} [val] If not specified, return the current
* position accessor. If specified, use this for the position accessor
* and return `this`. If a function is given, this is called with
* `(vertexElement, vertexIndex, dataElement, dataIndex)`.
* @returns {object|this} The current position or this feature.
*/
this.position = function (val) {
Expand Down

0 comments on commit 521d317

Please sign in to comment.