The documentation for the concurrent code in warzone is severely lacking
documentation (just like the rest of the code).

I just don't think it is acceptable for nuances of concurrent
programming to go undocumented, so I propose a new "rule" going forward:
Detailed documentation for all concurrent code must be created, no
exceptions.

By detailed documentation, I mean something like a sequence diagram in
the wiki, a large comment block explaining the flow/ sequence of events,
etc.

The minimum that should be explained (imo): thread lifetimes,
synchronization, message passing.

Thoughts?

I'll help out with this once my schedule clears up (i.e. I'm not just
trying to make work for others).

-Safety0ff

_______________________________________________
Warzone-dev mailing list
Warzone-dev@gna.org
https://mail.gna.org/listinfo/warzone-dev

Reply via email to