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

Fix duplicate slashes in URL links #21108

Conversation

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Apr 24, 2020
@philwebb philwebb added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Apr 24, 2020
@philwebb philwebb added this to the 2.3.x milestone Apr 24, 2020
@snicoll snicoll changed the title Fix dupulicate slashes in URL links Fix duplicate slashes in URL links Apr 25, 2020
@jkatada jkatada force-pushed the fix-duplicate-slashes-in-URL-links branch from 8f0d626 to a87a904 Compare April 25, 2020 10:49
@snicoll snicoll self-assigned this May 4, 2020
Copy link
Member

@snicoll snicoll left a comment

Choose a reason for hiding this comment

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

Thank you very much for raising your first PR @jkatada

Rather that removing the / after the variable, I'd like us to add it (if necessary) and remove it from the variable. We can see that's what we've done for code there and it reads more naturally to me.

Would you have time to rework the PR in that direction?

@@ -91,7 +91,7 @@ private void writeTable(AutoConfiguration autoConfigurationClasses) throws IOExc
writer.println();
writer.printf("| {spring-boot-code}/spring-boot-project/%s/src/main/java/%s.java[`%s`]%n",
autoConfigurationClasses.module, autoConfigurationClass.path, autoConfigurationClass.name);
writer.printf("| {spring-boot-api}/%s.html[javadoc]%n", autoConfigurationClass.path);
writer.printf("| {spring-boot-api}%s.html[javadoc]%n", autoConfigurationClass.path);
Copy link
Member

Choose a reason for hiding this comment

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

I think we should rather stick to a / after the variable rather than no slash. This means that {spring-boot-api} would not end with a slash.

@snicoll snicoll added the status: waiting-for-feedback We need additional information before we can continue label May 4, 2020
@jkatada jkatada force-pushed the fix-duplicate-slashes-in-URL-links branch from a87a904 to 3f8c56e Compare May 5, 2020 00:00
@jkatada
Copy link
Contributor Author

jkatada commented May 5, 2020

@snicoll Thanks for the feedback. I've updated the PR. Please review.

@spring-projects-issues spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels May 5, 2020
@snicoll snicoll removed the status: feedback-provided Feedback has been provided label May 5, 2020
@snicoll snicoll modified the milestones: 2.3.x, 2.3.0 May 5, 2020
snicoll pushed a commit that referenced this pull request May 5, 2020
@snicoll snicoll closed this in 8611b2c May 5, 2020
@snicoll
Copy link
Member

snicoll commented May 5, 2020

@jkatada thanks for the follow-up and for making your first contribution to Spring Boot.

@jkatada jkatada deleted the fix-duplicate-slashes-in-URL-links branch June 20, 2020 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants