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

PoC: comments with example of behavior on Observable #266

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

giollord
Copy link

Added comments for 6 functions with examples of behavior, similar to how they do it on ReactiveX website.
Also added class to sandbox/ConsoleApp1 that allow to generate more examples.

Not sure if this is a good way to make comments though:

  • 🟢 it's informative and could be useful for people like me who are not very familiar with reactive programming
  • 🔴 giant comments sometimes being troublesome when they pop up on half of screen.
  • 🔴 comments have to be stored in separate xml file
  • 🟢 but then can reuse them on other functions

Here is how it looks in VS 2022 on Windows:

Screenshots image_2024-10-25_174533933 image_2024-10-25_174640787

P.S.: This PR is more of a proof of concept. Unfortunately, can not guarantee that I will add much more docs even if it gets approved, but I will try to add at least some. Also descriptions and some example data were taken from ReactiveX website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant