Refactor: BinaryImporter optimization + javadoc#2525
Closed
capdevon wants to merge 4 commits into
Closed
Conversation
|
|
||
| /** | ||
| * Creates a new {@code BinaryImporter}. | ||
| */ |
Member
There was a problem hiding this comment.
Does this Javadoc provide any non obvious information?
Contributor
Author
There was a problem hiding this comment.
An empty default constructor clearly just creates a new instance. However, Javadoc for every constructor is a standard and necessary practice for the Java API. It ensures generated documentation is complete and maintains consistency throughout the project's style. Even if the content seems minimal, its presence is expected.
Raising questions on these well-established conventions slows down the review without adding significant value, and it takes away valuable time that could be dedicated to more complex and relevant code issues.
codex128
requested changes
Aug 11, 2025
Contributor
|
Closing because requested changes were ignored. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR improves the
BinaryImporterclass by modernizing its code and enhancing maintainability:These changes make the codebase easier to understand, safer, and more maintainable, while preserving existing functionality.