[LUCENE-9570] Review code diffs after automatic formatting and correct problems before it is applied

• Type: Sub-task
• Status: Reopened
• Priority: Blocker
• Resolution: Fixed
• Fix Version/s: 9.0
• Lucene Fields: New
• Assignee: Dawid Weiss
• Reporter: Dawid Weiss
• Created: 08/Oct/20 07:09
• Updated: 05/Aug/23 11:02
• Resolved: 05/Jan/21 12:45

Description

Review and correct all the javadocs before they're messed up by automatic formatting. Apply project-by-project, review diff, correct. Lots of diffs but it should be relatively quick.

Reviewing diffs manually

• switch to branch jira/LUCENE-9570 which the PR is based on:

  git remote add dweiss [e-mail]:dweiss/lucene-solr.git
  git fetch dweiss
  git checkout jira/LUCENE-9570
  

• Open gradle/validation/spotless.gradle and locate the project/ package you wish to review. Enable it in spotless.gradle by creating a corresponding switch case block (refer to existing examples), for example:

            case ":lucene:highlighter":
              target "src/**"
              targetExclude "**/resources/**", "**/overview.html"
              break
  

• Reformat the code:

  gradlew tidy && git diff -w > /tmp/diff.patch && git status
  

• Look at what has changed (git status) and review the differences manually (/tmp/diff.patch). If everything looks ok, commit it directly to jira/LUCENE-9570 or make a PR against that branch.

  git commit -am ":lucene:core - src/**/org/apache/lucene/document/**"
  

Issue Links

• links to: GitHub Pull Request #2153