search

interledgerjs / ilp-plugin-btp

This has been moved to the monorepo https://github.com/interledgerjs/interledgerjs
8 stars 7 forks source link

Code Comments #28

Closed dino-rodriguez closed 6 years ago

dino-rodriguez commented 6 years ago

Context: On the community call, we chatted about code comments and how they could be helpful in the interledger-js code.

I made some comments on the BTP code as I was going through it some time ago. They might be too verbose -- not sure. The comments are tsdocs compatible, and use some markdown styling as well for the generated documentation.

Not sure if this is something that should be merged into master or not, but thought it would be worth posting for consideration. Thanks @adrianhopebailie for bringing that up on the call.

karzak commented 6 years ago

Thanks @d1no007! +1 on having commented code in master.

dino-rodriguez commented 6 years ago

Great -- thanks @kincaidoneil @karzak! Seems a break statement after a return within a switch statement was causing the unreachable code. Changed that and turned the compiler option off.