Github user anew commented on a diff in the pull request:
https://github.com/apache/incubator-twill/pull/37#discussion_r32340804
--- Diff:
twill-core/src/main/java/org/apache/twill/internal/TwillContainerLauncher.java
---
@@ -68,6 +68,16 @@ public TwillContainerLauncher(RuntimeSpecification
runtimeSpec, ProcessLauncher.
this.secureStoreLocation = secureStoreLocation;
}
+ /**
+ * Start execution run for a class in a container. Will return instance
of {@link TwillContainerController}
+ * that allows send messages directly to the container.
+ *
+ * @param runId Use to represent unique id of the container run.
+ * @param instanceId The Twill instance Id
+ * @param mainClass The main class will be run in the a container.
--- End diff --
Looks like we Java itself does not put a period after the @param. Only if
it is a complete sentence. So you would either say:
{code}
@param mainClass The main class to run in the container
{code}
or
{code}
@param mainClass This is the main class that will run in the container.
{code}
I think typically the first one is preferred.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
