concordium-node-sdk-js icon indicating copy to clipboard operation
concordium-node-sdk-js copied to clipboard

Add doc comments to all public code in modules

Open soerenbf opened this issue 2 years ago • 2 comments

To give developers a better idea of the what types they're working with do, it would be good to have documentation in the form of doc comments to everything we export from the different modules.

soerenbf avatar Jun 22 '23 08:06 soerenbf

If we can prioritize implementing #212, we could eliminate the need to document many of the custom types added for gRPC v1 compatibility

soerenbf avatar Jun 22 '23 11:06 soerenbf

Also document the GRPC errors from here:

https://github.com/Concordium/concordium-node/blob/main/concordium-node/src/grpc2.rs

rasmus-kirk avatar Oct 03 '23 09:10 rasmus-kirk