-
Notifications
You must be signed in to change notification settings - Fork 119
[HIVEMALL-193] Implement a tool for generating a list of Hivemall UDFs #148
Conversation
hivemall.tool is very similar to hivemall.tools (in hivemall-core) and confusing.
tools/hivemall-docs/pom.xml
Outdated
</plugin> | ||
<plugin> | ||
<groupId>org.apache.maven.plugins</groupId> | ||
<artifactId>maven-shade-plugin</artifactId> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of using shaded jar, it's better to use MOJO.
Goals such as mvn hivemall-docs:gen_func_list
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Usage:
$ mvn org.apache.hivemall:hivemall-docs:generate-funcs-list
Lists of UDFs are written into target/funcs.md
and target/generic_funcs.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@takuti Why not directly update these files?
docs/gitbook/misc/funcs.md
docs/gitbook/misc/generic_funcs.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just in case, the generator defensively does so. If you feel directly over-writing docs/gitbook/*
is fine, I can update so.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I prefer directly updating them since it's intendedly updated by running mvn org.apache.hivemall:hivemall-docs:generate-funcs-list
.
If you are using git, there are no problem for undo.
Now |
LGTM. Merged! Thanks. |
What changes were proposed in this pull request?
Automatically generate a list of UDFs for:
Initial mock implementation: https://github.com/takuti/hivemalldoc
What type of PR is it?
Improvement, Documentation
What is the Jira issue?
https://issues.apache.org/jira/browse/HIVEMALL-193
How was this patch tested?
See output: https://gist.github.com/takuti/312d3a11bf85fc4044399d7e97a06f13
How to use this feature?
Checklist
mvn formatter:format
, for your commit?