You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by JonZeolla <gi...@git.apache.org> on 2016/12/31 14:39:19 UTC
[GitHub] incubator-metron pull request #407: METRON-643: Stellar function documentati...
GitHub user JonZeolla opened a pull request:
https://github.com/apache/incubator-metron/pull/407
METRON-643: Stellar function documentation needs to be updated
The documentation for some the `STATS_*` Stellar functions was moved from [here](https://github.com/apache/incubator-metron/tree/master/metron-platform/metron-common) to [here](https://github.com/apache/incubator-metron/tree/master/metron-analytics/metron-statistics) as of [this commit](https://github.com/apache/incubator-metron/commit/b1c89df6f0503e82d5a9c4b7ac9c9e82ea810491) but the documentation was not correctly updated.
This PR updates the core function table in [metron-common](https://github.com/apache/incubator-metron/tree/master/metron-platform/metron-common#stellar-core-functions) to point to the new locations, and fixes some minor typos.
The alternative would be to simply remove the `STATS_*` entries from the table in metron-common, and to add a pointer to the other locations where Stellar functions are documented. Open to feedback.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/JonZeolla/incubator-metron METRON-643
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-metron/pull/407.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #407
----
commit 58dcd7d0aa47e01b72b125ae1362c77698a39b29
Author: Jon Zeolla <ze...@gmail.com>
Date: 2016-12-31T14:08:49Z
METRON-643: Stellar function documentation needs to be updated
commit 792acb93d4a412209e3930fb517cc4bc69c22c12
Author: Jon Zeolla <ze...@gmail.com>
Date: 2016-12-31T14:12:01Z
METRON-643: Stellar function documentation needs to be updated
----
---
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.
---
[GitHub] incubator-metron issue #407: METRON-643: Stellar function documentation need...
Posted by nickwallen <gi...@git.apache.org>.
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.
---
[GitHub] incubator-metron issue #407: METRON-643: Stellar function documentation need...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on the issue:
https://github.com/apache/incubator-metron/pull/407
Note: `BIN` and `STATS_BIN` may be added via [METRON-637](https://github.com/apache/incubator-metron/pull/401) but the documentation in metron-common was not updated, potentially indicating a preference to remove the `STATS_*` documentation from the metron-common `README.md`.
I would suggest that at the end of the day we make sure there's a single place where people can go for Stellar function documentation, even if it's just a page of pointers to the various READMEs.
---
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.
---
[GitHub] incubator-metron pull request #407: METRON-643: Stellar function documentati...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-metron/pull/407
---
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.
---
[GitHub] incubator-metron issue #407: METRON-643: Stellar function documentation need...
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/incubator-metron/pull/407
@JonZeolla I agree; I like this approach. I will commit and update the `STATS_BIN` PR to conform to the new approach.
---
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.
---