[
https://issues.apache.org/jira/browse/MADLIB-923?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Frank McQuillan updated MADLIB-923:
-----------------------------------
Description:
As a MADlib user, I want to access on-line help in a consistent way, so that I
know what the syntax of the MADlib interface is.
Current MADlib on-line help is inconsistent. The current logic is:
| If function format is: | On-line help is: | Notes |
| madlib.function(); | no online help avail| i.e., when function takes no args |
| madlib.function('arg1'); | madlib.function(); | i.e., when function takes 1
arg |
| madlib.function('arg1', 'arg2', ...); | madlib.function();
madlib.function('usage'); madlib.function('example');| i.e., when function
takes more than 1 arg |
One suggestion is to add a consistent new help function for all modules in the
form:
| madlib.function_help(); | for all functions | e.g., logregr_train_help();|
Please create a JIRA for the particular changes that you make and link it to
this epic.
was:
As a MADlib user, I want to access on-line help in a consistent way, so that I
know what the syntax of the MADlib interface is.
Current MADlib on-line help is inconsistent. The current logic is:
| If function format is: | On-line help is: | Notes |
| madlib.function(); | no online help avail| i.e., when function takes no args |
| madlib.function('arg1'); | madlib.function(); | i.e., when function takes 1
arg |
| madlib.function('arg1', 'arg2', ...); | madlib.function();
madlib.function(usage); madlib.function(example);| i.e., when function takes
more than 1 arg |
One suggestion is to add a consistent new help function for all modules in the
form:
| madlib.function_help(); | for all functions | e.g., logregr_train_help();|
Please create a JIRA for the particular changes that you make and link it to
this epic.
> Improve on-line help
> --------------------
>
> Key: MADLIB-923
> URL: https://issues.apache.org/jira/browse/MADLIB-923
> Project: Apache MADlib
> Issue Type: Epic
> Components: Documentation
> Reporter: Frank McQuillan
> Priority: Minor
> Labels: starter
>
> As a MADlib user, I want to access on-line help in a consistent way, so that
> I know what the syntax of the MADlib interface is.
> Current MADlib on-line help is inconsistent. The current logic is:
>
> | If function format is: | On-line help is: | Notes |
> | madlib.function(); | no online help avail| i.e., when function takes no
> args |
> | madlib.function('arg1'); | madlib.function(); | i.e., when function takes
> 1 arg |
> | madlib.function('arg1', 'arg2', ...); | madlib.function();
> madlib.function('usage'); madlib.function('example');| i.e., when function
> takes more than 1 arg |
> One suggestion is to add a consistent new help function for all modules in
> the form:
> | madlib.function_help(); | for all functions | e.g., logregr_train_help();|
> Please create a JIRA for the particular changes that you make and link it to
> this epic.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
