leerho commented on code in PR #453:
URL: https://github.com/apache/datasketches-java/pull/453#discussion_r1228838393
##########
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:
The [Oracle Style
Guide](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#styleguide)
for Javadocs recommends using \<code\>...\</code\> for
- Java keywords
- package names
- class names
- method names
- interface names
- field names
- argument names
- code examples
This would represent a big cleanup of the entire repo if we were to decide
to do this.
--
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]
