search

aurae-runtime / aurae

Distributed systems runtime daemon written in Rust.
https://aurae.io
Apache License 2.0
1.83k stars 89 forks source link

adding some basic documentation for auraed source code #504

Closed taniwha3 closed 1 month ago

taniwha3 commented 1 month ago

Signed-off-by: Tani Aura 111664369+taniwha3@users.noreply.github.com

GANitak commented 1 month ago

FWIW I think the commentary lines can only help understand the step better for someone cruising the code without having a large amount of experience with this kind of code, or language. So it helps me, yes some of the lines are obvious, but others are not. Concerning the background noise, I can see that too. Maybe there is a way to hide comment sections somehow...? But more accessible information directly from the code base, a gain of time for the people. Can comments affect runtime seriously?