[
https://issues.apache.org/jira/browse/STORM-1047?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Karl Richter updated STORM-1047:
--------------------------------
Description:
The `python` script `bin/storm.py` is completely undocumented regarding it's
internals. Function comments only include a command line interface often
omitting an explanation of arguments and their default values (e.g. it should
be clear why the default value of `klass` of `nimbus` is
`"backtype.storm.daemon.nimbus"` because that doesn't make sense).
Also explanations like "Launches the nimbus daemon. [...]" (again `nimbus`
function) is good for a command line API doc, but insufficient for a function
documentation (should mention that it starts a `java` process and passes
`klass` as class name to it).
How does the script use `lib/`, `extlib/` and `extlib-daemon`? It's too complex
to squeeze this info out of the source code.
was:
The `python` script `bin/storm.py` is completely undocumented regarding it's
internals. Function comments only include a command line interface often
omitting an explanation of arguments and their default values (e.g. it should
be clear why the default value of `klass` of `nimbus` is
`"backtype.storm.daemon.nimbus"` because that doesn't make sense).
Also explanations like "Launches the nimbus daemon. [...]" (again `nimbus`
function) is good for a command line API doc, but insufficient for a function
documentation (should mention that it starts a `java` process and passes
`klass` as class name to it).
> document internals of bin/storm.py
> ----------------------------------
>
> Key: STORM-1047
> URL: https://issues.apache.org/jira/browse/STORM-1047
> Project: Apache Storm
> Issue Type: Bug
> Affects Versions: 0.10.0
> Reporter: Karl Richter
> Labels: documentation
>
> The `python` script `bin/storm.py` is completely undocumented regarding it's
> internals. Function comments only include a command line interface often
> omitting an explanation of arguments and their default values (e.g. it should
> be clear why the default value of `klass` of `nimbus` is
> `"backtype.storm.daemon.nimbus"` because that doesn't make sense).
> Also explanations like "Launches the nimbus daemon. [...]" (again `nimbus`
> function) is good for a command line API doc, but insufficient for a function
> documentation (should mention that it starts a `java` process and passes
> `klass` as class name to it).
> How does the script use `lib/`, `extlib/` and `extlib-daemon`? It's too
> complex to squeeze this info out of the source code.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
