Skip to content

Fix inconsistent strong tag appearance in documentation #4177

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

Conversation

Ahli
Copy link
Contributor

@Ahli Ahli commented Sep 21, 2022

In the documentation key words that use tags, e.g. "NOTE:" or "INFO:" were inconsistently formatted.
I have:

  • capitalized the entire key word (NOTE, INFO)
  • added/moved the : inside the tags
  • added/moved the whitespace after the closing tag

Unfortunately, your code formatting instructions caused changes to most files (I used current version of IntelliJ and the eclipse formatter adapter plugin and I have applied the import settings to a fresh copy of intellij's default profile),
=> Since this PR is adding at most a single character into java docs, it should not cause any problems.
However, multiple existing lines already exceed 120 chars

My first contribution here! :)

  • [x ] You have read the Spring Data contribution guidelines.
  • You use the code formatters provided here and have them applied to your changes. Don’t submit any formatting related changes.
  • You submit test cases (unit or integration tests) that back your changes.
  • You added yourself as author in the headers of the classes you touched. Amend the date range in the Apache license header if needed. For new types, add the license header (copy from another file and set the current year only).

@pivotal-cla
Copy link

@Ahli Please sign the Contributor License Agreement!

Click here to manually synchronize the status of this Pull Request.

See the FAQ for frequently asked questions.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Sep 21, 2022
@pivotal-cla
Copy link

@Ahli Thank you for signing the Contributor License Agreement!

@christophstrobl
Copy link
Member

thank you @Ahli - merged to main development line.

@christophstrobl christophstrobl added this to the 4.1 GA (2023.0.0) milestone Apr 20, 2023
@christophstrobl christophstrobl added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Apr 20, 2023
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.

4 participants