adding some basic documentation for auraed source code #504
Conversation
Signed-off-by: Tani Aura <111664369+taniwha3@users.noreply.github.com>
| macro_rules! do_in_cell { | ||
| ($self:ident, $cell_name:ident, $function:ident, $request:ident) => {{ | ||
| // Lock the cells mutex to ensure exclusive access |
There was a problem hiding this comment.
in general I'm not a huge fan of comments that describe the code that is already readable. I prefer to keep comments for methods/classes and any tricky bits of code. that way readers know to pay attention to the comments that exist and they don't become background noise that readers ignore. does that make sense?
| @@ -145,6 +170,13 @@ impl CellService { | |||
| }) | |||
| } | |||
|
|
|||
| /// Frees a cell. Will delocate the cell. | |||
|
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. |
Signed-off-by: Tani Aura 111664369+taniwha3@users.noreply.github.com