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

Javadoc for PathPatternParser.defaultInstance is outdated #30976

Closed
chipu opened this issue Aug 1, 2023 · 2 comments
Closed

Javadoc for PathPatternParser.defaultInstance is outdated #30976

chipu opened this issue Aug 1, 2023 · 2 comments
Assignees
Labels
in: web Issues in web modules (web, webmvc, webflux, websocket) type: documentation A documentation task
Milestone

Comments

@chipu
Copy link

chipu commented Aug 1, 2023

Affects: 6.0.11

Current Javadoc for PathPatternParser defaultInstance:

	/**
	 * Shared, read-only instance of {@code PathPatternParser}. Uses default settings:
	 * <ul>
	 * <li>{@code matchOptionalTrailingSeparator=true}
	 * <li>{@code caseSensitivetrue}
	 * <li>{@code pathOptions=PathContainer.Options.HTTP_PATH}
	 * </ul>
	 */

But matchOptionalTrailingSeparator is false, and = is missing in the next line: caseSensitive=true

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Aug 1, 2023
@sbrannen
Copy link
Member

sbrannen commented Aug 2, 2023

I've edited your comment to improve the formatting. You might want to check out this Mastering Markdown guide for future reference.

@sbrannen sbrannen changed the title Wrong javadoc in spring-web 6.0.11, PathPatternParser.java Wrong Javadoc in PathPatternParser in spring-web 6.0.11 Aug 2, 2023
@sbrannen sbrannen added type: documentation A documentation task in: web Issues in web modules (web, webmvc, webflux, websocket) labels Aug 2, 2023
@sbrannen sbrannen self-assigned this Aug 2, 2023
@sbrannen sbrannen removed the status: waiting-for-triage An issue we've not yet triaged or decided on label Aug 2, 2023
@sbrannen sbrannen added this to the 6.0.12 milestone Aug 2, 2023
@sbrannen sbrannen changed the title Wrong Javadoc in PathPatternParser in spring-web 6.0.11 Javadoc for PathPatternParser.defaultInstance is outdated Aug 2, 2023
@sbrannen
Copy link
Member

sbrannen commented Aug 2, 2023

@chipu, congratulations on submitting your first issue for the Spring Framework! 👍

This has been addressed in 6.0.x and main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: web Issues in web modules (web, webmvc, webflux, websocket) type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

3 participants