Skip to content

Don't use markdown syntax in javadoc or error messages #28408

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

Closed
wilkinsona opened this issue Oct 21, 2021 · 2 comments
Closed

Don't use markdown syntax in javadoc or error messages #28408

wilkinsona opened this issue Oct 21, 2021 · 2 comments
Assignees
Labels
type: documentation A documentation update
Milestone

Comments

@wilkinsona
Copy link
Member

Classes and utilities designed to work with the `javax.servlet` specification.

It should probably be {@code javax.servlet} instead.

@wilkinsona wilkinsona added this to the 2.4.x milestone Oct 21, 2021
@wilkinsona wilkinsona added the type: documentation A documentation update label Oct 21, 2021
@philwebb philwebb self-assigned this Oct 21, 2021
@philwebb philwebb changed the title Package description for org.springframework.boot.web.servlet uses Markdown syntax Don't use markdown syntax in javadoc or error messages Oct 21, 2021
@philwebb
Copy link
Member

We actually have quite a few more than just that package. I'll increase the scope of this and do a sweep to remove them all.

@wilkinsona
Copy link
Member Author

wilkinsona commented Oct 22, 2021

Reopening to reinstate the use of backticks where the text is ultimately rendered using Asciidoctor and to use ' in configuration property javadoc comments.

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

No branches or pull requests

2 participants