Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve IpAddress#toString API/docs. #553

Merged
merged 1 commit into from
Jan 8, 2024

Conversation

NthPortal
Copy link
Contributor

Add protected method to IpAddress that #toString delegates to, making it clearer to users from the IpAddress trait alone that #toString returns a reasonable representation (and the one they want).

@CLAassistant
Copy link

CLAassistant commented Dec 29, 2023

CLA assistant check
All committers have signed the CLA.

@NthPortal
Copy link
Contributor Author

to elaborate on the commit message, if you click through toString on IpAddress in your IDE of choice to look at its implementation, it brings you to j.l.Object#toString, since nothing in IpAddress enforces that its implementations override toString. this PR changes that

@mpilquist
Copy link
Member

mpilquist commented Dec 31, 2023

Thanks, looks good to me! We just need a mima exclusion.

Add protected method to `IpAddress` that `#toString` delegates to,
making it clearer to users from the `IpAddress` trait alone that
`#toString` returns a reasonable representation (and the one they
want).
@NthPortal
Copy link
Contributor Author

We just need a [mima] exclusion.

sorry this took so long for me to get to. life happened at me. but it's done now

@mpilquist
Copy link
Member

No worries, and thanks for fixing that typo. Auto-correct got me again. :)

@mpilquist mpilquist merged commit 4a188a7 into Comcast:main Jan 8, 2024
10 checks passed
@NthPortal NthPortal deleted the better-toString/PR branch April 22, 2024 04:53
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.

3 participants