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

API documentation incomplete #64

Open
deklanw opened this issue Jun 8, 2019 · 2 comments
Open

API documentation incomplete #64

deklanw opened this issue Jun 8, 2019 · 2 comments

Comments

@deklanw
Copy link

deklanw commented Jun 8, 2019

I can't find any docs for moment And, the difference from lift isn't clear. Over here you explain it kinda,
funkia/turbine#51 (comment) but that should be more promiment

I can't find any docs for accumCombine. I think I see what it does, though.

I'm sure there's more but that's just what I noticed while looking through TodoMVC.

Are these docs autogenerated? I could try to write some docs but I want to make sure I understand if they're gen'd.

@paldepind
Copy link
Member

Hi @deklanw. Thank you for pointing this out 👍 We've definitely missed some functions in the documentation.

I can't find any docs for moment And, the difference from lift isn't clear. Over here you explain it kinda,
funkia/turbine#51 (comment) but that should be more promiment

Yes. Please see #66 which attempts to document moment. I'd love to hear what you think.

Are these docs autogenerated? I could try to write some docs but I want to make sure I understand if they're gen'd.

Long term we'd like to autogenerate the documentation. But, right now the documentation is just manually added in the readme. You are ve,ry welcome to try and write some docs. PR's would be really appreciated 👍

Also, I'll soon get around to reply to all the great issues you've opened. I've just been really busy with exams lately.

@paldepind
Copy link
Member

Current status.

  • moment
  • accumCombine

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