Karl Richter created STORM-1047: ----------------------------------- Summary: 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
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). -- This message was sent by Atlassian JIRA (v6.3.4#6332)