Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct typo (documentation only) #2447

Merged
merged 1 commit into from
Aug 31, 2014
Merged

Conversation

lazaruslarue
Copy link
Contributor

corrected homophonic spelling error

corrected homonym error.
@tschaub
Copy link
Member

tschaub commented Jul 25, 2014

Thanks @lazaruslarue. While you're tweaking that, what do you think about making it read "Overlay where the sketch features are drawn" or something?

@lazaruslarue
Copy link
Contributor Author

I think that's an excellent suggestion, which raises a different question:

Which features are drawn on that overlay? It's only a single feature, or a collection of features? It seems from this.features_ that it's a collection. So, how about:

"Overlay where the collection of sketched features are drawn."

?

@tschaub
Copy link
Member

tschaub commented Jul 26, 2014

The "sketch features" are parts of the feature currently being drawn. For a line this is one feature with a linestring geometry and one feature with a point geometry (at the head of the linestring). Once drawing is complete, the drawn feature is rendered elsewhere.

So your doc is correct, but it does give the impression that this is a large collection of features. At most it is a collection of two.

@lazaruslarue
Copy link
Contributor Author

Thanks for the added detail @tschaub. You're right, I didn't understand that this collection was only for the sketching features. Is this correct?

this.sketchFeature_: holds at most two features which (for polygons or linestrings) make up the linestring+endpoint that will be added to the Feature on drawend, e.g. next mousedown.
&&
this.features_: holds the target collection, where sketched features are sent after sketching.

How about: "Temporary overlay for drawing sketch features until they're added to the target layer."

Additionally, while it is clear after spending a bit reading the code, I could definitely see a use case for more documentation about the difference between sketching and drawing features. If there's an issue for more docs about this, I'd contribute to it... or open that issue if it's not there already ;)

Thanks!

tschaub added a commit that referenced this pull request Aug 31, 2014
@tschaub tschaub merged commit 273ba5f into openlayers:master Aug 31, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants