Style and Conventions

[c0gent]

Expound on code style and library related conventions.

[c0gent]

CONVENTIONS

---

idx: current index (of a loop, workgroup, queue, etc.)
- almost always a physical in-memory address

idz := index[0], first element, starting element

idz_parent: first element within the subset of a parent group
- ex.: syn_idx := syn_idz_den + syn_id_den

idn := index[len]: element after final element, termination point
- ex.: for(int i = 0, i < idn, i++)

idm := index[max] := index[len - 1]: final (valid) element just before idn. idn - 1 = idm.
- ex.: for(int i = 0, i <= idm, i++)

id: identifier, but not a physical array index

id_parent: identifier within the subset of a parent group
- ex.: syn_idx := syn_idz_den + syn_id_den

***** High Priority Comment, Temporary Code Change
<<<<< Medium Priority Comment, To Do
##### Debug Message Prefix

[c0gent]

Elaborate on fully expanded function definition style.
ex:

pub fn my_function(
    &mut self, 
    important_param: u8,
    awesome_thing: AwesomeThing,
    //old_thing: Vec<OldStuff>,
    optional_thing: Option<usize>,
) -> ReturnedThing {
    ...
}

All lines are easily comment-out-able.