8000 Added Streams selection to API docs by SteveALee · Pull Request #597 · cyclejs/cyclejs · GitHub
[go: up one dir, main page]
Skip to content

Added Streams selection to API docs #597

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Added Streams selection to API docs #597

wants to merge 3 commits into from

Conversation

SteveALee
Copy link
Contributor

I hope this helps. It is not a complete PR though.

  • I added new tests for the issue I fixed/built
  • I ran yarn test for the package I'm modifying
  • I used yarn run commit instead of git commit

I couldn't figure out all the details for these for the docs. Let me know and I'll address them.

Also the other API docs have the JSDocs appended at #API which does not apply to this new page. I could not figure out how that is done in order to ensure it was disabled.

@staltz
Copy link
Member
staltz commented May 5, 2017 •
edited
Loading

Hi @SteveALee , thank you for taking your time to send us this PR. The api section is only for "API references" like listing the functions of a package. I'm not sure what you meant with "Streams selection" but in Getting Started we already explain how you can choose which stream library. What was your vision for this?

@SteveALee
Copy link
Contributor Author

@staltz Ah, it seems I should have made that clearer.

a) we discussed adding links to the Stream docs - this could also be done in the individual Run pages
b) I feel that as streams are such a significant part of Cycle usage and used in the APIs that for completeness the supported streams should be mentioned and signposted in the reference section. Also for on boarding it makes the Ref section more complete, even if introduction section was not recently read.

Looks like I forgot the links which were the original motivation :(

If you feel this is useful then I'll add the links. If not then no matter.

@staltz staltz force-pushed the master branch 2 times, most recently from 19355d6 to 61f81cf Compare October 26, 2017 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

PR: work in progress

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@SteveALee @staltz
0