[
https://issues.apache.org/jira/browse/METRON-643?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15798443#comment-15798443
]
ASF GitHub Bot commented on METRON-643:
---------------------------------------
Github user nickwallen commented on the issue:
https://github.com/apache/incubator-metron/pull/407
+1 Looks good, Jon.
I agree with you that we need one single, searchable "thing" documenting
all of the Stellar functions. The approach that you took here gives us that. I
prefer your approach over simply having one link to the 'metron-statistics'
README which would make a user click through to multiple READMEs and search
each one.
Longer term, we really need something along the lines of auto-generated
documentation that gets published with each release. The approach we currently
have is difficult to maintain and is destined to fall out-of-sync from the
underlying code.
> Stellar function documentation needs to be updated
> --------------------------------------------------
>
> Key: METRON-643
> URL: https://issues.apache.org/jira/browse/METRON-643
> Project: Metron
> Issue Type: Bug
> Reporter: Jon Zeolla
> Assignee: Jon Zeolla
> Priority: Trivial
>
> The documentation for some of the stats functions was moved from
> https://github.com/apache/incubator-metron/tree/master/metron-platform/metron-common
> to
> https://github.com/apache/incubator-metron/tree/master/metron-analytics/metron-statistics
> as of
> https://github.com/apache/incubator-metron/commit/b1c89df6f0503e82d5a9c4b7ac9c9e82ea810491
> but the documentation was not correctly updated.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
