pigato icon indicating copy to clipboard operation
pigato copied to clipboard

Code Documentation

Open leonpegg opened this issue 10 years ago • 4 comments

Even though the code in the library is quite easy to understand, it might be worth considering adding jsdoc comments.

I would happily do this if others agree its a good idea.

leonpegg avatar Apr 07 '15 11:04 leonpegg

Pigato code is quite small but probably we can still improve readability. Documentation is important for the Pigato future to have an higher adoption rate. We should have that if not now, maybe in the future. A standardised documentation help also people to follow the guidelines when they create Pigato compatible Client and Workers in other languages.

prdn avatar Apr 07 '15 13:04 prdn

Glad you agree on code documentation. I am happy to add jsdoc comments into the code.

leonpegg avatar Apr 07 '15 13:04 leonpegg

@leonpegg thank you very much for your help.

prdn avatar Apr 07 '15 13:04 prdn

Great ideas guys, I really hope to have a use case for this someday. I'll need to invent something.

quantuminformation avatar Apr 27 '15 12:04 quantuminformation