search

funkia / hareactive

Purely functional reactive programming library
MIT License
338 stars 29 forks source link

API documentation incomplete #64

Open deklanw opened 5 years ago

deklanw commented 5 years ago

I can't find any docs for moment And, the difference from lift isn't clear. Over here you explain it kinda, https://github.com/funkia/turbine/issues/51#issuecomment-307372077 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 commented 5 years ago

Hi @deklanw. Thank you for pointing this out :+1: 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 :+1:

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 commented 5 years ago

Current status.