fix: add javadoc to core (part i) #648
Open
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
Signed-off-by: MBWhite <[email protected]>
nielspardon
requested review from
andrew-coleman,
benbellick,
bestbeforetoday and
vbarua
benbellick
approved these changes
Jan 8, 2026
Member
benbellick
left a comment
benbellick
left a comment
There was a problem hiding this comment.
Thanks for doing this! Just left one comment about some comments being extra, but you can take it or leave it.
Just curious, are there plans in the future to enforce that all public methods have associated javadoc comments?
Comment on lines
+12
to
+53
|
|
||
| /** Extension identifier for approximate aggregate functions. */ | ||
| public static final String FUNCTIONS_AGGREGATE_APPROX = | ||
| "extension:io.substrait:functions_aggregate_approx"; | ||
|
|
||
| /** Extension identifier for generic aggregate functions. */ | ||
| public static final String FUNCTIONS_AGGREGATE_GENERIC = | ||
| "extension:io.substrait:functions_aggregate_generic"; | ||
|
|
||
| /** Extension identifier for arithmetic functions. */ | ||
| public static final String FUNCTIONS_ARITHMETIC = "extension:io.substrait:functions_arithmetic"; | ||
|
|
||
| /** Extension identifier for decimal arithmetic functions. */ | ||
| public static final String FUNCTIONS_ARITHMETIC_DECIMAL = | ||
| "extension:io.substrait:functions_arithmetic_decimal"; | ||
|
|
||
| /** Extension identifier for boolean functions. */ | ||
| public static final String FUNCTIONS_BOOLEAN = "extension:io.substrait:functions_boolean"; | ||
|
|
||
| /** Extension identifier for comparison functions. */ | ||
| public static final String FUNCTIONS_COMPARISON = "extension:io.substrait:functions_comparison"; | ||
|
|
||
| /** Extension identifier for datetime functions. */ | ||
| public static final String FUNCTIONS_DATETIME = "extension:io.substrait:functions_datetime"; | ||
|
|
||
| /** Extension identifier for geometry functions. */ | ||
| public static final String FUNCTIONS_GEOMETRY = "extension:io.substrait:functions_geometry"; | ||
|
|
||
| /** Extension identifier for logarithmic functions. */ | ||
| public static final String FUNCTIONS_LOGARITHMIC = "extension:io.substrait:functions_logarithmic"; | ||
|
|
||
| /** Extension identifier for rounding functions. */ | ||
| public static final String FUNCTIONS_ROUNDING = "extension:io.substrait:functions_rounding"; | ||
|
|
||
| /** Extension identifier for decimal rounding functions. */ | ||
| public static final String FUNCTIONS_ROUNDING_DECIMAL = | ||
| "extension:io.substrait:functions_rounding_decimal"; | ||
|
|
||
| /** Extension identifier for set functions. */ | ||
| public static final String FUNCTIONS_SET = "extension:io.substrait:functions_set"; | ||
|
|
||
| /** Extension identifier for string functions. */ |
Member
There was a problem hiding this comment.
IMO, these comments are a bit excessive and I would drop them. That's just my opinion though :)
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.
No description provided.