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

Include most.create in API docs #341

Open
Rich-Harris opened this issue Oct 12, 2016 · 3 comments
Open

Include most.create in API docs #341

Rich-Harris opened this issue Oct 12, 2016 · 3 comments

Comments

@Rich-Harris
Copy link

Follow up to Gitter discussion:

For folks like me who are coming to most.js without a reactive programming background, it can be a very steep learning curve. One of the things that would make it much easier to adopt streams incrementally (both as a mental concept and in a codebase) is an obvious escape hatch for when you need to write some dirty old-fashioned imperative code.

most.create seems to fit that bill perfectly, but it took me a very long time to discover it (and when I did, it was by accident – a throwaway remark in an unrelated thread). I propose adding it to the 'creating streams' section of the API docs, but with a health warning, perhaps something along the following lines:

For when you absolutely, positively have to add items to a stream manually. Using create should be considered an anti-pattern – there are usually more declarative ways to achieve the same end result – but it's a useful escape hatch for when you really need it

@davidchase
Copy link
Collaborator

had an idea about this thought i would run it by you guys... instead of adding create back into the API docs since it really lives outside of this repo now. A add modules table to the README similar to https://github.com/paldepind/flyd#modules

that list all of the current stream modules in https://github.com/mostjs and maybe even https://github.com/mostjs-community it gives both exposure and a nice way to add external modules into the README

thoughts?

@briancavalier
Copy link
Member

@davidchase That's an interesting idea. Are you thinking we'd put the list directly in the README, or do you see it living in the wiki?

@Rich-Harris What do you think of that idea? Do you think it would have helped you discover @most/create?

@davidchase
Copy link
Collaborator

@briancavalier yeah i can see it in the README just because its right there... might be "better" found because its the 1st thing anyone sees when they are coming to a github repo.

I sometimes myself forget about the wiki feature 😞

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

3 participants