docs(distinctUntilChanged): fix docs rendering #6756
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
3 tasks
Comment on lines
-136
to
-139
| export function distinctUntilChanged<T, K>( | ||
| comparator: (previous: K, current: K) => boolean, | ||
| keySelector: (value: T) => K | ||
| ): MonoTypeOperatorFunction<T>; |
There was a problem hiding this comment.
Moved to top.
Comment on lines
-94
to
-99
| * 1. It will always emit the first value from the source. | ||
| * 2. The `keySelector` will be run against all values, including the first value. | ||
| * 3. For all values after the first, the selected key will be compared against the key selected from | ||
| * the previously emitted value using the `comparator`. | ||
| * 4. If the keys are determined to be unequal by this check, the value (not the key), is emitted | ||
| * and the selected key from that value is saved for future comparisons against other keys. |
3 tasks
benlesh
approved these changes
Apr 19, 2022
benlesh
added
7.x
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.
Description:
Please check the related issue for more info. This is how the page looks like with this fix (sorry for the large image):
One note: I'm not an expert, but it looks like that having multiple JSDocs comments on the same function overload (for two or more overloads) don't really work with the docs rendering scripts. Maybe there is an option to turn it on, but for now, all documentation should be contained in one JSDocs comment (
/** here */) instead of having it in multiple comments (for example, one for each overload).Related issue (if exists):
Closes #6660