Add extended documentation for all reactive operators#71
Merged
glopesdev merged 9 commits intobonsai-rx:mainfrom Dec 28, 2022
Merged
Add extended documentation for all reactive operators#71glopesdev merged 9 commits intobonsai-rx:mainfrom
glopesdev merged 9 commits intobonsai-rx:mainfrom
Conversation
bruno-f-cruz
approved these changes
Dec 27, 2022
Collaborator
bruno-f-cruz
left a comment
bruno-f-cruz
left a comment
There was a problem hiding this comment.
Check individual comments. Mostly just some warnings that I feel should be included and minimal motif examples for some operators. Otherwise it reads super clear!
bruno-f-cruz
approved these changes
Dec 27, 2022
glopesdev
changed the title
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds extended documentation for all core operators.
It covers specific mechanics of all reactive operators and schedulers, including possible pitfalls, caveats and limitations. Cross-references are used to provide links between related operators. Examples and notice boxes are used to clarify and emphasize specific behaviors.