Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doc comments to all public code in modules #210

Open
soerenbf opened this issue Jun 22, 2023 · 2 comments
Open

Add doc comments to all public code in modules #210

soerenbf opened this issue Jun 22, 2023 · 2 comments
Labels
[Type] Task An additional feature or improvement.

Comments

@soerenbf
Copy link
Collaborator

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 soerenbf added the [Type] Task An additional feature or improvement. label Jun 22, 2023
@soerenbf soerenbf mentioned this issue Jun 22, 2023
Merged
5 tasks
@soerenbf
Copy link
Collaborator Author

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

@rasmus-kirk
Copy link
Collaborator

Also document the GRPC errors from here:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
[Type] Task An additional feature or improvement.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@soerenbf @rasmus-kirk