leerho commented on code in PR #453:
URL: https://github.com/apache/datasketches-java/pull/453#discussion_r1228832310
##########
src/main/java/org/apache/datasketches/theta/Sketch.java:
##########
@@ -193,43 +193,50 @@ public static Sketch wrap(final Memory srcMem, final long
expectedSeed) {
//Sketch interface
/**
- * Converts this sketch to a ordered CompactSketch on the Java heap.
+ * Converts this sketch to a ordered CompactSketch.
*
- * <p>If this sketch is already in the proper form, this method returns
<i>this</i>,
- * otherwise, this method returns a new CompactSketch of the proper form.
+ * <p>If <i>this.isCompact() == true</i> this method returns <i>this</i>,
Review Comment:
It is not so clear that \<em\> is necessarily the correct answer either.
Even though Java documentation does use it.
"The \<i\> element represents text that is set off from the normal prose,
such as a foreign word, fictional character thoughts, or when the text refers
to the definition of a word instead of representing its semantic meaning."
"An example for \<em\> could be: "Just _do_ it already!", or: "We _had_ to
do something about it". A person or software reading the text would pronounce
the words in italics with an emphasis, using verbal stress." [The emphasis
element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em)
I don't think someone reading these javadoc aloud would use verbal stress on
these words.
Is it such a big deal?
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
