[MADLIB-923] Improve on-line help

• Type: Epic
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: Documentation
• Labels: starter
• Assignee: Unassigned
• Reporter: Frank McQuillan
• Created: 16/Nov/15 20:46
• Updated: 21/Jun/17 00:02

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.

Issue Links

• mentioned in: Page Loading...