Skip to content

Improve readability of MessageSourceSupport Javadoc #26874

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

Merged

Conversation

hrybs
Copy link
Contributor

@hrybs hrybs commented Apr 29, 2021

The Javadoc of org.springframework.context.support.MessageSourceSupport class contains unreadable piece of text for method setAlwaysUseMessageFormat(boolean).
We need to replace """ with "''".

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Apr 29, 2021
Copy link

@cuspymd cuspymd left a comment

Choose a reason for hiding this comment

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

It would be nice if "true" and "false" were also expressed as code tags. And MessageFormat appears several times during the explanation, and it would be good if its were expressed consistently with code tag.

@sbrannen sbrannen changed the title Fix MessageSourceSupport JavaDoc Improve readability of MessageSourceSupport Javadoc Apr 29, 2021
@sbrannen sbrannen added type: task A general task and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Apr 29, 2021
@sbrannen sbrannen self-assigned this Apr 29, 2021
@sbrannen sbrannen added this to the 5.3.7 milestone Apr 29, 2021
@sbrannen sbrannen merged commit 118c7f9 into spring-projects:main Apr 29, 2021
@sbrannen
Copy link
Member

Good catch.

The font used in the generated HTML does indeed make it difficult to discern that there are two single quotes. They are there, but the human eye practically cannot detect that.

This has been merged into main.

Thanks

sbrannen added a commit that referenced this pull request Apr 29, 2021
@sbrannen
Copy link
Member

It would be nice if "true" and "false" were also expressed as code tags. And MessageFormat appears several times during the explanation, and it would be good if its were expressed consistently with code tag.

@cuspymd, I agree and made those changes in 7316dc7.

lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this pull request Mar 26, 2022
lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this pull request Mar 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: task A general task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants