Improve documentation about ronin HOT 6 CLOSED

is this prompted by the docstrings? regardless, I was thinking we should be able to display them in an helpful way- and use similar technique for javascript implemented functions

const fn = a => a + 1;
fn.help = "some docstring"
console.log(fn.help) // some docstring

non tested possible implementation:

function withDocs = (docstring, function) => {
function.docstring = docstring
return function
}

from ronin.

Someone asked me if there was a documentation of the library and there isn't it would be nice if the readme had a list of the functions and their parameters.

from ronin.

Ah yes! I'm thinking too far for now, a static doc would be essential

from ronin.

https://github.com/hundredrabbits/Ronin/blob/master/documentation.md

from ronin.

There's now a list of current existing functions, would be great to add more details and examples

from ronin.

Added documentation tool :)

ronin.commander.docs.toMarkdown()

We'll need to make sure that all functions are following the same format tho, that'll mean wrapping everything within () => {}.

from ronin.