Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/1242
Just to chime in, understand _why_ something was done is important in
maintaining the code down the line. @mmiklavc will not be the only one working
on this code forever, and as such there should be some documentation somewhere
for areas, no matter where they are, to explain important implementation
decisions and concepts. The code is the ultimate source of truth, so I would
prefer there. As someone who has to go spelunking through undocumented metron
source, almost all of which I did not write or review, I can testify to this
being helpful and in fact necessary if going forward we want to avoid
regressions.
Side effects of methods are important too.
I think we should require javadoc and checkstyle for it, and would be doing
so if we could get to a state where it would build with it on.
---
