lacking documentation
joelnet opened this issue · comments
lacking documentation for available functions.
we should add type signature to all functions (in source file and/or in README or wiki) and then we could create a more detailed documentation.
// append :: String -> String -> String (is this right?)
const append = post => pre =>
`${pre}${post}`I don't know much about type signatures but I can help (and learn in the process)
Good idea, I agree. I was working on docs last night. It was time consuming. I don't think I'll be able to do it all at once. So I'll merge in a few docs and iterate as I create more.
I know... documentation is very tedious. I prefer to create some examples only haha
I added some docs here: https://github.com/joelnet/MojiScript/tree/story/documentation
The examples I have been creating are fully runnable examples starting at main. I guess we'll see how that goes. Examples here: https://github.com/joelnet/MojiScript/blob/story/documentation/API.md
I added some type definitions. Hopefully I didn't make too many mistakes.
I haven't merged it into master because it's very sparse. I figure it should be about 80% complete (at least) before merging it in.
If you want to tackle some off this list, you can branch off of. Let me know though so we don't duplicate our efforts.
@joelnet I'm trying setup a codesandbox with eslint (to lint mojiscript). But without success yet. Do you know how to do this?
I was trying to do the same earlier. I would really like to use codesandbox for demos. Not possible at the moment. It looks like they are actively working on it though codesandbox/codesandbox-client#127.