ademakov commented on code in PR #965:
URL: https://github.com/apache/ignite-3/pull/965#discussion_r937631161
##########
modules/schema/src/main/java/org/apache/ignite/internal/schema/BinaryTupleSchema.java:
##########
@@ -289,10 +289,23 @@ public static int nullMapSize(int numElements) {
}
/**
- * Returns the null map size in bytes if there are nullable elements, zero
otherwise.
+ * Get offset of the byte that contains null-bit of a given tuple element.
Review Comment:
Well, are you talking about style or grammar? I know that sun/oracle
recommends using 3rd person indicative in the docs. So this should go as "Gets
...". I don't understand why you urge to use "Returns ...", there is no basis
for this neither in oracle recommendations nor in English grammar.
As for grammar, I'd personally prefer to use imperative mood. It is quite
often used in documentation elsewhere and IMHO more correct than the 3rd person
indicative. "Gets ..." is not a full sentence. A full sentence in indicative
mood requires a subject. So to stay grammatically correct it should be written
like this "This method gets ...". It is strange why oracle promotes bad English
in their recommendations. But so be it.
--
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]
