docs(ripple): add section about global options #4239
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
* Adds a new section about global ripple options to the `README.md` file of the ripple directive. Closes angular#4226
googlebot
added
the
cla: yes
willshowell
reviewed
Apr 28, 2017
src/lib/core/ripple/README.md
Outdated
| | Name | Type | Description | | ||
| | --------------- | ------- | ----------------------------------------- | | ||
| | disabled | boolean | Whether ripples should show or not. | | ||
| | baseSpeedFactor | number | Factor to adjust duration of the ripples. | |
There was a problem hiding this comment.
I think it would make more sense to say "Factor to adjust ripple speed". The current phrasing makes it seem like higher values result in higher duration.
There was a problem hiding this comment.
Yep. I agree with that. Changed
mmalerba
approved these changes
Apr 28, 2017
mmalerba
added
pr: lgtm
action: merge
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
README.mdfile of the ripple directive.@mmalerba Not sure if the documentation for the
baseSpeedFactoris good. I had hard times to explain that the factor is like a "percentage". Value1.5makes ripples animate 50% faster than normal.Closes #4226