fix: javadoc for isthmus-cli and examples #644
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JavaDoc fixes to ensure the examples and isthmus-cli are clean. Not expecting these to be published, as not APIs to use directly. Signed-off-by: MBWhite <[email protected]>
nielspardon
requested review from
andrew-coleman,
benbellick,
bestbeforetoday and
vbarua
nielspardon
reviewed
Jan 8, 2026
examples/isthmus-api/src/main/java/io/substrait/examples/SchemaHelper.java
Outdated
Show resolved
Hide resolved
nielspardon
reviewed
Jan 8, 2026
examples/isthmus-api/src/main/java/io/substrait/examples/SchemaHelper.java
Outdated
Show resolved
Hide resolved
nielspardon
reviewed
Jan 8, 2026
| /** Indent character. */ | ||
| protected String indentChar = " "; | ||
|
|
||
| /** Indents of idnentsize to use. */ |
Member
There was a problem hiding this comment.
It feels to me like if we have fields with the same semantic they should have the same documentation. So I would use the same comment also for the previous ones in FunctionArgStringify and ParentStringify.
Suggested change
| /** Indents of idnentsize to use. */ | |
| /** Number of indents to use. */ |
nielspardon
reviewed
Jan 8, 2026
Comment on lines
+59
to
+62
| * Get the outdent to use, decreats indent counter. | ||
| * | ||
| * @param sb Stribug Builder with outdent | ||
| * @return outdent string |
Member
There was a problem hiding this comment.
Suggested change
| * Get the outdent to use, decreats indent counter. | |
| * | |
| * @param sb Stribug Builder with outdent | |
| * @return outdent string | |
| * Get the outdent to use, decreaces the indent counter. | |
| * | |
| * @param sb {@link StringBuilder} with the outdent | |
| * @return outdent string |
nielspardon
reviewed
Jan 8, 2026
| /** | ||
| * Constructor. | ||
| * | ||
| * @param indent numver of idents to use |
Member
There was a problem hiding this comment.
Suggested change
| * @param indent numver of idents to use | |
| * @param indent number of indents to use |
nielspardon
reviewed
Jan 8, 2026
| import org.graalvm.nativeimage.hosted.RuntimeReflection; | ||
| import org.immutables.value.Value; | ||
|
|
||
| /** */ |
Member
There was a problem hiding this comment.
Suggested change
| /** */ | |
| /** GraalVM {@link Feature} used during native image generation which registers classes for reflection at runtime using {@link RuntimeReflection}. */ |
nielspardon
reviewed
Jan 8, 2026
| package io.substrait.isthmus.cli; | ||
|
|
||
| /** */ | ||
| public class InitializeAtBuildTime {} |
Member
There was a problem hiding this comment.
looks like more dead code that we can drop. I don't think this class is used anywhere.
…SchemaHelper.java Co-authored-by: Niels Pardon <[email protected]>
…SchemaHelper.java Co-authored-by: Niels Pardon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
JavaDoc fixes to ensure the examples and isthmus-cli are clean. Not expecting these to be published, as not APIs to use directly.