metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nickwallen <...@git.apache.org>
Subject [GitHub] incubator-metron issue #407: METRON-643: Stellar function documentation need...
Date Wed, 04 Jan 2017 14:54:33 GMT
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.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message