alievmirza commented on code in PR #1840:
URL: https://github.com/apache/ignite-3/pull/1840#discussion_r1152910866
##########
modules/api/src/main/java/org/apache/ignite/IgnitionManager.java:
##########
@@ -36,9 +36,9 @@ public class IgnitionManager {
private static Ignition ignition;
/**
- * Starts an Ignite node with a bootstrap configuration from a HOCON file.
+ * Starts an Ignite node with an optional bootstrap configuration from an
input stream with a HOCON configuration file.
Review Comment:
Why did bootstrap configuration become an optional parameter? Is it correct
to write that HOCON configuration file come from input stream, when we pass a
Path to the file?
Also, we have two methods for start (see `start(String nodeName, Path
cfgPath, Path workDir, @Nullable ClassLoader clsLdr)`), but its java doc do not
contain such changes, why?
##########
modules/api/src/main/java/org/apache/ignite/lang/UnexpectedNullValueException.java:
##########
@@ -20,8 +20,8 @@
import java.util.UUID;
/**
- * This exception is thrown instead of returning a null value from a method
which doesn't respect {@code null}-value to avoid ambiguity
- * whether the value is absent or value is {@code null}.
+ * This exception is thrown instead of returning a null value from a method
that does not respect {@code null}-value to avoid ambiguity
Review Comment:
redundant whitespace
##########
modules/api/src/main/java/org/apache/ignite/sql/ResultSetMetadata.java:
##########
@@ -24,17 +24,17 @@
*/
public interface ResultSetMetadata {
/**
- * Returns metadata with description for every column in result set.
+ * Returns metadata with a description for every column in the result set.
*
- * @return Columns metadata.
+ * @return Column metadata.
*/
List<ColumnMetadata> columns();
/**
- * Returns column index in columns list by given column name.
+ * Returns a column index for the column with a giveb name.
Review Comment:
given
##########
modules/api/src/main/java/org/apache/ignite/sql/Session.java:
##########
@@ -298,7 +298,7 @@ default long[] executeBatch(@Nullable Transaction
transaction, String dmlQuery,
CompletableFuture<Void> executeScriptAsync(String query, @Nullable
Object... arguments);
/**
- * Return default query timeout which bound query execution time. In case
a query take more time it's will be interrupted.
+ * Returns a default query timeout.
Review Comment:
why did we remove part with `In case a query take more time it's will be
interrupted.`? It brings some valuable information
##########
modules/api/src/main/java/org/apache/ignite/table/mapper/Mapper.java:
##########
@@ -117,9 +117,10 @@ static <O> Mapper<O> of(@NotNull Class<O> type, @NotNull
String fieldName, @NotN
return builder(type).map(Objects.requireNonNull(fieldName),
Objects.requireNonNull(columnName), fieldColumnPairs).build();
}
+ //What does "@return Mapper ." above mean?
Review Comment:
???
##########
modules/api/src/main/java/org/apache/ignite/network/TopologyService.java:
##########
@@ -21,12 +21,12 @@
import org.jetbrains.annotations.Nullable;
/**
- * Entry point for obtaining information about a cluster's physical topology.
+ * Entry point for obtaining cluster topology information.
Review Comment:
why did we remove `physical` part?
##########
modules/api/src/main/java/org/apache/ignite/table/Tuple.java:
##########
@@ -29,11 +29,11 @@
import org.jetbrains.annotations.NotNull;
/**
- * Tuple represents arbitrary set of columns whose values is accessible by
column name.
- * Attention: column name arguments passed to the methods of the tuple must
use SQL-parser style quotation, e.g.
- * "myColumn" - means name "MYCOLUMN", "\"MyColumn\"" - "MyColumn", etc.
+ * Tuple represents an arbitrary set of columns whose values are accessible by
column name.
+ * Column name arguments passed to the tuple methods must use SQL-parser
style notation; e.g.,
Review Comment:
```suggestion
* Column name arguments passed to the tuple methods must use SQL-parser
style notation; e.g.,
```
##########
modules/api/src/main/java/org/apache/ignite/lang/IgniteCheckedException.java:
##########
@@ -74,21 +74,21 @@ public IgniteCheckedException(UUID traceId, int code) {
}
/**
- * Creates a new exception with the given error code and detail message.
+ * Creates am exception with the given error code and detailed message.
Review Comment:
an
##########
modules/api/src/main/java/org/apache/ignite/network/TopologyService.java:
##########
@@ -21,12 +21,12 @@
import org.jetbrains.annotations.Nullable;
/**
- * Entry point for obtaining information about a cluster's physical topology.
+ * Entry point for obtaining cluster topology information.
Review Comment:
I see that it was made for all mentions of the `physical` topology in the
file. I think that `physical` part is important because Ignie has `physical`
and `logical` topologies.
##########
modules/api/src/main/java/org/apache/ignite/lang/ColumnNotFoundException.java:
##########
@@ -38,23 +38,22 @@ public ColumnNotFoundException(String columnName) {
}
/**
- * Create a new exception with given column name.
+ * Creates an exception with a given column name.
*
- * @param schemaName Name of the schema the table belongs to.
- * @param tableName Name of the table the column belongs to.
- * @param columnName Name of the column of interest.
+ * @param columnName Column name.
Review Comment:
Why did you remove `schemaName` parameter?
##########
modules/api/src/main/java/org/apache/ignite/sql/reactive/ReactiveResultSet.java:
##########
@@ -24,46 +24,46 @@
import org.jetbrains.annotations.Nullable;
/**
- * Reactive result set provides methods to subscribe to the query results in
reactive way.
+ * Provides methods to subscribe to query results in a reactive way.
*
- * <p>Note: It implies to be used with the reactive framework such as
ProjectReactor or R2DBC.
+ * <p>Note: To be used with the acreactive framework, such as ProjectReactor
or R2DBC.
Review Comment:
acreactive?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
