Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extended documentation for all reactive operators #71

Merged
merged 9 commits into from
Dec 28, 2022

Conversation

glopesdev
Copy link
Member

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.

@glopesdev glopesdev added the documentation Improvements or additions to documentation label Dec 27, 2022
Copy link
Collaborator

@bruno-f-cruz bruno-f-cruz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

@glopesdev glopesdev changed the title Add extended documentation for all core operators Add extended documentation for all reactive operators Dec 28, 2022
@glopesdev glopesdev merged commit e225fa8 into bonsai-rx:main Dec 28, 2022
@glopesdev glopesdev deleted the extended-docs branch December 28, 2022 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants