Improve docs for interaction.Select #2269
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
| @@ -1928,7 +1928,8 @@ olx.interaction.SelectOptions.prototype.addCondition; | |||
| /** | |||
| * A function that takes an {@link ol.MapBrowserEvent} and returns a boolean | |||
| * to indicate whether that event should be handled. | |||
| * By default, {@link ol.events.condition.singleClick} toggles the selection. | |||
| * By default, {@link ol.events.condition.singleClick} makes this feature | |||
| * the selected one. Additional features can be added with the `toggle` option. | |||
There was a problem hiding this comment.
I do not understand "By default, {@link ol.events.condition.singleClick} makes this feature the selected one." Is it just me?
|
rewritten. Hope this is now clear |
|
I like it. @elemoine, do you agree? |
| @@ -1928,7 +1928,12 @@ olx.interaction.SelectOptions.prototype.addCondition; | |||
| /** | |||
| * A function that takes an {@link ol.MapBrowserEvent} and returns a boolean | |||
| * to indicate whether that event should be handled. | |||
| * By default, {@link ol.events.condition.singleClick} toggles the selection. | |||
| * This is the toggle for the selected features as a whole. By default, this is | |||
There was a problem hiding this comment.
I find the word "toggle" a bit confusing here. But again this may be just me. Leave it if you think it makes sense.
|
It looks good to me too. I just added two new comments. We can merge this when my second comment is addressed. Thanks! |
|
revised version |
elemoine
pushed a commit
that referenced
this pull request
Jul 3, 2014
Improve docs for interaction.Select
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.
Attempts to make the options clearer.