Adding some missing descriptions... #3114
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
Adding some missing descriptions to match the documentation. Adding zoom.wheelDelta. Unsure of would be preferred, so I put it after zoom.filter to match the d3-zoom documentation.
nathanbraddock
approved these changes
Jul 8, 2017
nathanbraddock
approved these changes
Jul 8, 2017
nathanbraddock
approved these changes
Jul 8, 2017
curran
suggested changes
Jul 8, 2017
API.md
Outdated
| @@ -241,8 +241,8 @@ Drag and drop SVG, HTML or Canvas using mouse or touch input. | |||
| * [*drag*.clickDistance](https://github.com/d3/d3-drag/blob/master/README.md#drag_clickDistance) - set the click distance threshold. | |||
| * [*drag*.on](https://github.com/d3/d3-drag/blob/master/README.md#drag_on) - listen for drag events. | |||
| * [*event*.on](https://github.com/d3/d3-drag/blob/master/README.md#event_on) - listen for drag events on the current gesture. | |||
| * [d3.dragDisable](https://github.com/d3/d3-drag/blob/master/README.md#dragDisable) - | |||
| * [d3.dragEnable](https://github.com/d3/d3-drag/blob/master/README.md#dragEnable) - | |||
| * [d3.dragDisable](https://github.com/d3/d3-drag/blob/master/README.md#dragDisable) - prevents native drag-and-drop and text selection on the specified window. | |||
There was a problem hiding this comment.
Nice additions! A few notes:
- The "on the specified window" doesn't really make sense, without the context of the argument. Maybe best to leave it out.
- The other blurbs use things like "set" and "listen", rather than "sets" and "listens", so for consistency, I'd suggest making it start with "prevent".
So my final suggested wording would be:
- "prevent native drag-and-drop and text selection"
- "enable native drag-and-drop and text selection"
There was a problem hiding this comment.
I wasn't sure, so I just went with what it said in the d3-drag docs, but this makes sense. I'll make the change, thanks!
nathanbraddock
approved these changes
Jul 8, 2017
| * [*quadtree*.remove](https://github.com/d3/d3-quadtree/blob/master/README.md#quadtree_remove) - remove a datum from a quadtree. | ||
| * [*quadtree*.removeAll](https://github.com/d3/d3-quadtree/blob/master/README.md#quadtree_removeAll) - |
|
These changes look good to me. |
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.
Adding some missing descriptions to match the documentation.
Also adding zoom.wheelDelta. Unsure of would be preferred, so I put it after zoom.filter to match the d3-zoom documentation.