Github user cestella commented on the issue:
https://github.com/apache/incubator-metron/pull/234
@nickwallen Thanks for the feedback. I'm going to disagree heartily that
we should spend much time constructing javadocs for an API that is extremely
fluid and changing. To put it frankly, we are in a state of extreme code churn
as we grow the platform and those kinds of docs tend to go stale very quickly.
I would rather see more focus on external documentation on the portions of the
stack which are stable.
At this point in our maturity, we expect a certain ability to grok code by
reading it with the judicious help of the integration tests, unit tests and a
debugger. This is precisely why I spent so much time constructing an
integration test harness, so we could trace code to better understand it.
TL;DR: Your position around javadocs and general code documentation is not
committer consensus and may not (is not IMO) the best approach for this
position in our maturity.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
