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

What are the $s in variable names? #48

Open
graue opened this issue Sep 12, 2019 · 1 comment
Open

What are the $s in variable names? #48

graue opened this issue Sep 12, 2019 · 1 comment

Comments

@graue
Copy link

graue commented Sep 12, 2019

As a n00b to this library and observables, it's not clear why a lot of the variables in the README's examples have dollar signs at the end of their names.

Explaining the convention would make your project more accessible.

(Following the links to other libraries cited is not helpful either: the first code examples given in the docs for both Cycle.js and redux-observable also introduce dollar-sign variables with no explanation.)

@artfuldev
Copy link
Member

$ is read as stream so pong$ is read as pong stream. I am not sure if this is a question, hence tried answering. If you wish to improve the documentation, I think we need this effort put in, yes.

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

No branches or pull requests

2 participants