Skip to content

Clarify truncate method Javadoc#1536

Closed
Akshat19Upadhyay wants to merge 4 commits intoapache:masterfrom
Akshat19Upadhyay:patch-1
Closed

Clarify truncate method Javadoc#1536
Akshat19Upadhyay wants to merge 4 commits intoapache:masterfrom
Akshat19Upadhyay:patch-1

Conversation

@Akshat19Upadhyay
Copy link
Copy Markdown

Improves the truncate method documentation to better describe substring behavior.

Thanks for your contribution to Apache Commons! Your help is appreciated!

Before you push a pull request, review this list:

  • Read the contribution guidelines for this project.
  • Read the ASF Generative Tooling Guidance if you use Artificial Intelligence (AI).
  • I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute?
  • Run a successful build using the default Maven goal with mvn; that's mvn on the command line by itself.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process.

Akshat19Upadhyay and others added 2 commits December 19, 2025 22:23
Improves the truncate method documentation to better describe substring behavior.
Copy link
Copy Markdown
Member

@garydgregory garydgregory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @Akshat19Upadhyay
Thank you for the PR.
Please rebase on git master and see my comment.

Comment thread src/main/java/org/apache/commons/lang3/StringUtils.java Outdated
Clarifies return value description and removes extra line break.
Copy link
Copy Markdown
Member

@garydgregory garydgregory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new text is wrong.

Updates the truncate Javadoc to clarify behavior when the String is shorter than maxWidth and that zero is a valid non-negative value.
@Akshat19Upadhyay
Copy link
Copy Markdown
Author

Thanks for the review.
I have updated the Javadoc to fix the inaccurate wording and ensure it matches the actual truncate behavior, including the non-negative maxWidth case.
Please let me know if anything else needs adjustment.

Copy link
Copy Markdown
Member

@garydgregory garydgregory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new text is still wrong.

@Akshat19Upadhyay
Copy link
Copy Markdown
Author

Hi @garydgregory, thanks for the review.
I have tried to align the Javadoc with the actual behavior of truncate, but I’m still missing something.
Could you please point out which part of the text is incorrect or suggest the wording you’d expect?
That would really help me fix it properly. Thanks!

garydgregory added a commit that referenced this pull request Jan 19, 2026
- Pick up one change from PR #1536
- Apply same change to the method that calls the above
@garydgregory
Copy link
Copy Markdown
Member

Hello @Akshat19Upadhyay

I picked up the change that I think matters in git master (@param) and also applied it to the other truncate method, which was not done in this PR. You are credited in changes.xml

Thank you!
Closing this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants