Fix grammatical errors in MemorySize Javadocs - #4834
Closed
venkateshwaracholan wants to merge 3 commits into
Closed
Conversation
github-project-automation
Bot
moved this from PRs In Progress
to Done
in Basic Kanban Board
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
1 participant
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.
Summary
This PR fixes two small grammatical issues in the public Javadocs for MemorySize.
Although the changes are purely documentation-related, these Javadocs are part of the public API and appear in generated documentation. Correcting the wording improves clarity for users and helps maintain a polished and professional developer experience.
Changes
Updated the class-level Javadoc:
calls to asLong() the result in an ArithmeticException
→ calls to asLong() may result in an ArithmeticException
Updated the valueOf(String) Javadoc:
If the value contain no suffix
→ If the value contains no suffix
No code changes or behavioral modifications were made.
Checklist
CHANGELOG.md(if needed)site/content/in-dev/unreleased(if needed)