omniscientjs / immstruct

Immutable data structures with history for top-to-bottom properties in component based libraries like React. Based on Immutable.js
374 stars 21 forks source link

Fix errors in api.md #85

Closed leonyu closed 8 years ago

mikaelbr commented 8 years ago

Hi. Thanks for the PR and fix, but the apm.md is actually generated from the jsdocs in the files. If you could update the source code instead (e.g. here), I'd be happy to merge.

leonyu commented 8 years ago

Done.

Also having to read into JSDoc documentation, it appears following can be updated:

Do you want me to update those as well? I could do as separate PR.

References:

P.S. This came out of my working on creating a TypeScript definition for this project.

mikaelbr commented 8 years ago

@leonyu Cool. Sure, you can just update this PR as it's more about correcting the jsdocs rather than the api.md. So I think it's fitting for this PR.

Funny you should do this now, I've been thinking of doing the same thing after researching different transpilation languages (thereof funscript and typescript). Perfect timing :cake: :+1:

leonyu commented 8 years ago

I left Void alone, cause Dox generates empty string in the markdown when I put void or undefined, which I felt was less desirable. Should be good.

mikaelbr commented 8 years ago

Great job. Merging now. :+1: