metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cestella <>
Subject [GitHub] incubator-metron issue #234: METRON-397: Add a stellar function to interact ...
Date Tue, 13 Sep 2016 13:48:17 GMT
Github user cestella commented on the issue:
    @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 or file a JIRA ticket
with INFRA.

View raw message