Update documentation for pointFeature. #858
Conversation
manthey
force-pushed
the
update-point-docs
branch
2 times, most recently
from
29c3596 to
306b12d
Compare
src/gl/pointFeature.js
Outdated
| /** | ||
| * Set style(s) from array(s). For each style, the array should have one | ||
| * value per data item. The values are not converted or validated. Color | ||
| * values should be {@link geo.geoColorObject}s. If invalid values are given |
There was a problem hiding this comment.
is "s" after the "}" intentional?
There was a problem hiding this comment.
Yes. It makes the docs read 'Color values should be geo.geoColorObjects.', which seemed more grammatical, but I'm not committed to the 's'.
There was a problem hiding this comment.
I am fine with this. You could have said that 'Color' values should a a geo.geoColorObject.
There was a problem hiding this comment.
I reworded it a little.
src/pointFeature.js
Outdated
| * @property {number} [width=256] | ||
| * @property {number} [height=256] | ||
| */ | ||
| // TODO: refactor point clustering to (a) not be based on window size, (b) use |
There was a problem hiding this comment.
perhaps we could create an issue for this and remove it from here?
There was a problem hiding this comment.
Apparently I already did (see issue #853). Do you want it removed? It stands as a warning to anyone using point clustering.
There was a problem hiding this comment.
I would remove it as it is not consistent and a user would not dig in the code as much I think.
This also touches documentation on util/clustering.js, though that could use some refactoring so that clusters are computed in map gcs rather than in feature gcs (usually interface gcs) and the cluster size is given in simpler units (such as display pixels). This fixes a number of trivial documentation issues in other files, too. Also, improve documentation of position in line and polygon features.
manthey
force-pushed
the
update-point-docs
branch
from
306b12d to
ad7646c
Compare
This also touches documentation on util/clustering.js, though that could use some refactoring so that clusters are computed in map gcs rather than in feature gcs (usually interface gcs) and the cluster size is given in simpler units (such as display pixels).
This fixes a number of trivial documentation issues in other files, too.