Clean-ups around javadocs #15
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vanekjar
reviewed
Feb 2, 2017
| @@ -21,17 +21,17 @@ | |||
|
|
|||
| /** | |||
| * Annotation marking an operator a {@code Basic} operator. | |||
| * A basic operator is such operator that an executor *must* implement | |||
| * in order to be able to run any flow. | |||
| * Such an operator *must* be implement (natively) by an executor | |||
| * @param <T> the type of elements in the dataset | ||
| * | ||
| * @param flow the flow to associate the dataset with | ||
| * @param source the source to represents as the returned dataset |
There was a problem hiding this comment.
represent or maybe the source producing the returned dataset?
| */ | ||
| public int size() { | ||
| return operators.size(); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve currently registered consumers of dataset. | ||
| * Determines the consumers of a given dataset asscuming that data set is directly |
There was a problem hiding this comment.
the consumers without the + assuming typo
| * | ||
| * @return a dataset representing the specified source | ||
| * | ||
| * @throws Exception if setting up the source fails for some reason | ||
| */ | ||
| public <T> Dataset<T> createInput(URI uri) throws Exception { | ||
| return createInput(getSourceFromURI(uri)); | ||
| } | ||
|
|
||
| /** | ||
| * Create new input dataset. |
| */ | ||
| @FunctionalInterface | ||
| public interface BinaryFunction<LEFT, RIGHT, OUT> extends Serializable { | ||
|
|
||
|
|
||
| /** Return the result of this function. */ | ||
| /** | ||
| * Return the result of this function. |
There was a problem hiding this comment.
This function returns result of this function, cpt. obvious 😄
We can omit that.
| @@ -100,6 +109,12 @@ public static TaskAttemptContext createTaskContext(Configuration conf, | |||
| /** | |||
| * Serialization helper to try deserializaing the given byte array into an object | |||
| * @return Modified configuration | ||
| * | ||
| * @throws IOException if serializaing the given data source fails for some reason |
| * | ||
| * @param operator the operator to inspect | ||
| * | ||
| * @return the given operotor's single input data set/stream |
| * Creates a new input/source data set based on the specified URI. | ||
| * | ||
| * @param <T> the type of elements extracted form the source; this is not | ||
| * type-safe. if a caller mixes up the source and the exected type from |
| @@ -28,13 +28,16 @@ | |||
| @Target(ElementType.TYPE) | |||
| public @interface Recommended { | |||
|
|
|||
| /** Textual documentation of the reason of the recommendation. */ | |||
| /** | |||
| * @return a human readable explanation why the annoated operator is recommendation | |||
xitep
force-pushed
the
pete/small-cleanups
branch
from
000a2a8
to
7ee2b97
Compare
|
@vanekjar many thanks for the correction suggestions! fixed all of them and squashed into the original commit. ready to merge. |
mareksimunek
pushed a commit
that referenced
this pull request
May 4, 2018
Clean-ups around javadocs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
mvn clean packageI'm not sure I can properly describe the generic type parameter onupdate: will resolve this separately. many thanks for the offline discussion!Dataset#getgetPartitioning()😟 May I ask for help on this one?