jmalkin commented on code in PR #453:
URL: https://github.com/apache/datasketches-java/pull/453#discussion_r1228797164
##########
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:
Two things here.
1) I think `<em>` is generally preferred to `<i>` in that it's semantic
rather than direct typesetting. What does italics mean if using a screen
reader, for instance?
2) For code snippets that aren't put into their own preformatted block, I
think `<tt>` is generally preferred over italicized text.
That's going to apply to a huge amount of javadocs in this repo, though, so
perhaps better suited to a dedicated PR that does only that change.
--
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]
