Skip to content

Fix links to Servlet and JPA javadoc #43320

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Fix links to Servlet and JPA javadoc #43320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions spring-boot-project/spring-boot-dependencies/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -763,7 +763,7 @@ bom {
links {
site(version -> "https://jakarta.ee/specifications/persistence/%s.%s"
.formatted(version.major(), version.minor()))
javadoc(version -> "https://jakarta.ee/specifications/persistence/%s.%s/apidocs"
javadoc(version -> "https://jakarta.ee/specifications/persistence/%s.%s/apidocs/jakarta.persistence"
Copy link

Choose a reason for hiding this comment

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

Instead of appending "jakarta.persistence" to the url, here you could leverage the third argument to .formatted(...) and use:

"https://jakarta.ee/specifications/persistence/%s.%s/apidocs/%s".formatted(...)
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for the comments, but this PR has already been merged. I also think the changes are better as they are now. Nothing's being appended and jakarta.persistence is an unchanging part of the string so there's no benefit in it being a format argument.
.formatted(version.major(), version.minor()), "jakarta.persistence")
releaseNotes(version -> "https://github.com/jakartaee/persistence/releases/tag/%s.%s-%s-RELEASE"
.formatted(version.major(), version.minor(), version))
Expand All @@ -782,7 +782,7 @@ bom {
links {
site(version -> "https://jakarta.ee/specifications/servlet/%s.%s"
.formatted(version.major(), version.minor()))
javadoc(version -> "https://jakarta.ee/specifications/servlet/%s.%s/apidocs"
javadoc(version -> "https://jakarta.ee/specifications/servlet/%s.%s/apidocs/jakarta.servlet"
Copy link

Choose a reason for hiding this comment

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

Instead of appending "jakarta.persistence" to the url, here you could leverage the third argument to .formatted(...) and use:

"https://jakarta.ee/specifications/servlet/%s.%s/apidocs/%s".formatted(...)
.formatted(version.major(), version.minor()), "jakarta.servlet")
}
}
Expand Down