Repository navigation
[LANG-1198] Javadoc: Clarify stripEnd character-set semantics - #1851
Merged
Merged
Conversation
Explain how stripping trailing characters differs from removing a whole suffix, with the reported example and links to Strings.CS.removeEnd. This changes documentation only and preserves the existing API and runtime behavior. Assisted-By: OpenAI Codex
garydgregory
requested changes
Nov 1, 2026
| <action type="fix" dev="ggregory" due-to="alhuda, Gary Gregory">Keep RandomStringUtils.random rejection cap from failing valid ranges (#1843).</action> | ||
| <action type="fix" dev="ggregory" due-to="Pendela Phanindra Rao, Gary Gregory">[javadoc] Correct hexadecimal output examples in Conversion (#1844).</action> | ||
| <action type="fix" dev="ggregory" due-to="Mohd Irshad, Gary Gregory">Fix Conversion hex method Javadoc (#1845).</action> | ||
| <action issue="LANG-1198" type="fix" due-to="rys888">Clarify the difference between stripping characters and removing a suffix in StringUtils.stripEnd Javadoc.</action> |
garydgregory
marked this pull request as draft
November 1, 2026 11:28
Revert the manually added changes.xml entry as requested by the maintainer. Preserve the stripEnd documentation clarification. Assisted-By: OpenAI Codex
garydgregory
changed the title
garydgregory
requested changes
Nov 1, 2026
Co-authored-by: Gary Gregory <[email protected]>
garydgregory
marked this pull request as ready for review
November 2, 2026 20:56
garydgregory
added a commit
that referenced
this pull request
Nov 2, 2026
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.
Related to LANG-1198.
The issue reports that
stripEnd("85123116", "16")was mistaken for removing the suffix "16". It actually strips trailing members of the character set and returns "85123".Clarify this distinction in stripEnd's Javadoc, link to
Strings.CSandStrings.removeEnd(String, CharSequence), and add the reported stripEnd example. The example list uses StringUtils consistently.This is a documentation clarification. It does not implement the issue's suggested char[] signature change or change runtime behavior. Issue closure is left to the maintainers.
Original validation (2026-11-01; JDK 21, Maven 3.9.16, compiler release 8):
mvn -B -ntp -s ../commons-lang-LANG-1198-validation/maven-settings.xml. Temporary settings use Maven Central without changing project configuration.Review follow-up (2026-11-01): Removed the changes.xml entry as requested. Non-test checks passed; tests were skipped in that follow-up.
Review follow-up (2026-11-02): Removed the
Strings.CS.removeEndexample line as requested, preserving the prose cross-reference. Enabled maintainer edits. The documented non-test build passed on retry (52.302 s):mvn -B -ntp -DskipTests -DskipITs -s ../commons-lang-LANG-1198-validation/maven-settings.xml. The first attempt failed fetching the external Commons IO Javadoc package-list. The retry passed; Javadoc reported its generated output up to date. Checked the generated HTML, unchanged runtime source, andgit diff --check. Tests were skipped; the test counts above are from the original submission.Checklist: